Fix Qt OpenGL overview.

Change-Id: Ib95638a8eb306e5ababa47cc61e1b5db4ae6cb31
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>

diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf
index 1565b03..2d8703a 100644 (file)
--- a/src/opengl/doc/qtopengl.qdocconf
+++ b/src/opengl/doc/qtopengl.qdocconf
@@ -1,42 +1,51 @@
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
-project                 = QtOpenGL
-description             = Qt OpenGL Reference Documentation
-url                     = http://qt-project.org/doc/qtopengl
-version                 = 5.0.0
-
-examplesinstallpath     = opengl
-
-qhp.projects            = QtOpenGL
-
-qhp.QtOpenGL.file         = qtopengl.qhp
-qhp.QtOpenGL.namespace           = org.qt-project.qtopengl.500
-qhp.QtOpenGL.virtualFolder       = qtopengl
-qhp.QtOpenGL.indexTitle          = Qt OpenGL
-qhp.QtOpenGL.indexRoot           =
-
-qhp.QtOpenGL.filterAttributes    = qtopengl 5.0.0 qtrefdoc
-qhp.QtOpenGL.customFilters.Qt.name = QtOpenGL 5.0.0
-qhp.QtOpenGL.customFilters.Qt.filterAttributes = qtopengl 5.0.0
-
-qhp.QtOpenGL.subprojects         = classes
-qhp.QtOpenGL.subprojects.classes.title = C++ Classes
-qhp.QtOpenGL.subprojects.classes.indexTitle = Qt OpenGL C++ Classes
-qhp.QtOpenGL.subprojects.classes.selectors = class fake:headerfile
-qhp.QtOpenGL.subprojects.classes.sortPages = true
-
-tagfile                 = ../../../doc/qtopengl/qtopengl.tags
-
-depends                 += qtcore qtgui qtwidgets qtdoc
-
-headerdirs  += ..
+# Name of the project which must match the outputdir. Determines the .index file
+project = qtopengl
+
+# Directories in which to search for files to document and images.
+# By default set to the root directory of the project for sources
+# and headers and qdoc will therefore generate output for each file.
+# Images should be placed in <rootdir>/dic/images and examples in
+# <rootdir>/examples.
+# Paths are relative to the  location of this file.
+exampledirs += ../../../examples/dbus \
+               snippets
 
+headerdirs += ..
 sourcedirs  += .. \
                ../../../examples/opengl/doc/src
-
 exampledirs += ../../../examples/opengl \
                ../ \
                snippets
-
 imagedirs   += images \
                ../../../examples/opengl/doc/images
+
+depends += qtcore qtgui qtwidgets
+
+# The following parameters are for creating a qhp file, the qhelpgenerator
+# program can convert the qhp file into a qch file which can be opened in
+# Qt Assistant and/or Qt Creator.
+
+# Defines the name of the project. You cannot use operators (+, =, -) in
+# the name. Properties for this project are set using a qhp.<projectname>.property
+# format.
+qhp.projects = qtopengl
+
+# Sets the name of the output qhp file.
+qhp.qtopengl.file = qtopengl.qhp
+
+# Namespace for the output file. This namespace is used to distinguish between
+# different documentation files in Creator/Assistant.
+qhp.qtopengl.namespace = org.qt-project.qtopengl.500
+
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.qtopengl.indexTitle = Qt Script Documentation
+
+# Only update the name of the project for the next variables.
+qhp.qtopengl.virtualFolder  = qtopengl
+qhp.qtopengl.subprojects = classes
+qhp.qtopengl.subprojects.classes.title = Qt D-Bus C++ Classes
+qhp.qtopengl.subprojects.classes.selectors = class fake:headerfile
+qhp.qtopengl.subprojects.classes.sortPages = true

diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
new file mode 100644 (file)
index 0000000..041751b
--- /dev/null
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtopengl-index.html
+    \title Qt OpenGL
+    \brief The QtOpenGL module offers classes that make it easy to
+    use OpenGL in Qt applications.
+
+    \warning Apart from the \l{QGLWidget} class, this module should not be used
+    anymore for new code. Please use the corresponding OpenGL classes in
+    \l{Qt Gui}.
+
+    OpenGL is a standard API for rendering 3D graphics. OpenGL only
+    deals with 3D rendering and provides little or no support for GUI
+    programming issues. The user interface for an OpenGL application
+    must be created with another toolkit, such as Cocoa on the Mac OS X
+    platform, Microsoft Foundation Classes (MFC) under Windows, or Qt
+    on both platforms.
+
+    \note OpenGL is a trademark of Silicon Graphics, Inc. in
+    the United States and other countries.
+
+    The Qt OpenGL module makes it easy to use OpenGL in Qt applications.
+    It provides an OpenGL widget class that can be used just like any
+    other Qt widget, except that it opens an OpenGL display buffer where
+    you can use the OpenGL API to render the contents.
+
+    To include the definitions of the module's classes, use the
+    following directive:
+
+    \snippet code/doc_src_qtopengl.cpp 0
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \snippet code/doc_src_qtopengl.pro 1
+
+    The Qt OpenGL module is implemented as a platform-independent Qt/C++
+    wrapper around the platform-dependent GLX (version 1.3 or later),
+    WGL, or AGL C APIs. Although the basic functionality provided is very
+    similar to Mark Kilgard's GLUT library, applications using the Qt
+    OpenGL module can take advantage of the whole Qt API for
+    non-OpenGL-specific GUI functionality.
+
+    The \l{Qt OpenGL C++ classes} page gives an overview over the available classes
+    int this module.
+*/

diff --git a/src/opengl/doc/src/qtopengl.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc
similarity index 93%
rename from src/opengl/doc/src/qtopengl.qdoc
rename to src/opengl/doc/src/qtopengl-module.qdoc
index 38f9a0b..11322bb 100644 (file)
--- a/src/opengl/doc/src/qtopengl.qdoc
+++ b/src/opengl/doc/src/qtopengl-module.qdoc
@@ -27,13 +27,17 @@
 
 /*!
     \module QtOpenGL
-    \title QtOpenGL Module
+    \title Qt OpenGL C++ classes
     \ingroup modules
     \ingroup technology-apis
 
     \brief The QtOpenGL module offers classes that make it easy to
     use OpenGL in Qt applications.
 
+    \warning Apart from the \l{QGLWidget} class, this module should not be used
+    anymore for new code. Please use the corresponding OpenGL classes in
+    \l{Qt Gui}.
+
     OpenGL is a standard API for rendering 3D graphics. OpenGL only
     deals with 3D rendering and provides little or no support for GUI
     programming issues. The user interface for an OpenGL application