summaryrefslogtreecommitdiffstats
path: root/src/opengl/doc/qtopengl.qdocconf
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@digia.com>2012-11-29 13:54:31 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-30 00:49:21 +0100
commitc85ca8d1cf2bf637014f82e732ee897e2fe2dafa (patch)
treee40ed63acd58a09794d5eef859ef36359b51cbcb /src/opengl/doc/qtopengl.qdocconf
parentf810c9fc330e41230321442e3fa06edb2fd95ee6 (diff)
Fix Qt OpenGL overview.
Change-Id: Ib95638a8eb306e5ababa47cc61e1b5db4ae6cb31 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
Diffstat (limited to 'src/opengl/doc/qtopengl.qdocconf')
-rw-r--r--src/opengl/doc/qtopengl.qdocconf73
1 files changed, 41 insertions, 32 deletions
diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf
index 1565b03bb0..2d8703a1dc 100644
--- 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