From f810c9fc330e41230321442e3fa06edb2fd95ee6 Mon Sep 17 00:00:00 2001
From: Lars Knoll <lars.knoll@digia.com>
Date: Thu, 29 Nov 2012 12:14:07 +0100
Subject: Fixes to Qt D-Bus docs

Change-Id: Ib13dc69edce9b989915e4eb75421e775b173095b
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
---
 src/dbus/doc/qtdbus.qdocconf | 69 ++++++++++++++++++++++++--------------------
 1 file changed, 37 insertions(+), 32 deletions(-)

(limited to 'src/dbus/doc/qtdbus.qdocconf')

diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf
index 6b695549df..20b327f9fb 100644
--- a/src/dbus/doc/qtdbus.qdocconf
+++ b/src/dbus/doc/qtdbus.qdocconf
@@ -1,42 +1,47 @@
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
-project                 = QtDBus
-description             = Qt DBus Reference Documentation
-url                     = http://qt-project.org/doc/qtdbus
-version                 = 5.0.0
-
-examplesinstallpath     = dbus
-
-qhp.projects            = QtDBus
-
-qhp.QtDBus.file         = qtdbus.qhp
-qhp.QtDBus.namespace           = org.qt-project.qtdbus.500
-qhp.QtDBus.virtualFolder       = qtdbus
-qhp.QtDBus.indexTitle          = Qt D-Bus
-qhp.QtDBus.indexRoot           =
-
-qhp.QtDBus.filterAttributes    = qtdbus 5.0.0 qtrefdoc
-qhp.QtDBus.customFilters.Qt.name = QtDBus 5.0.0
-qhp.QtDBus.customFilters.Qt.filterAttributes = qtdbus 5.0.0
+# Name of the project which must match the outputdir. Determines the .index file
+project = qtdbus
+
+# 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
 
-qhp.QtDBus.subprojects         = classes
-qhp.QtDBus.subprojects.classes.title = C++ Classes
-qhp.QtDBus.subprojects.classes.indexTitle = Qt D-Bus C++ Classes
-qhp.QtDBus.subprojects.classes.selectors = class fake:headerfile
-qhp.QtDBus.subprojects.classes.sortPages = true
+headerdirs += ..
+imagedirs += images
+sourcedirs += ..
+excludedirs += ../../../examples/widgets/doc
 
-tagfile                 = ../../../doc/qtdbus/qtdbus.tags
+depends += qtcore
 
-depends                 += qtcore
+# 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.
 
-headerdirs  += ..
+# 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 = qtdbus
 
-sourcedirs  += ..
+# Sets the name of the output qhp file.
+qhp.qtdbus.file = qtdbus.qhp
 
-exampledirs += ../../../examples/dbus \
-               ../ \
-               snippets
+# Namespace for the output file. This namespace is used to distinguish between
+# different documentation files in Creator/Assistant.
+qhp.qtdbus.namespace = org.qt-project.qtdbus.500
 
-excludedirs += ../../../examples/widgets/doc
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.qtdbus.indexTitle = Qt Script Documentation
 
-imagedirs   += images
+# Only update the name of the project for the next variables.
+qhp.qtdbus.virtualFolder  = qtdbus
+qhp.qtdbus.subprojects = classes
+qhp.qtdbus.subprojects.classes.title = Qt D-Bus C++ Classes
+qhp.qtdbus.subprojects.classes.selectors = class fake:headerfile
+qhp.qtdbus.subprojects.classes.sortPages = true
-- 
cgit v1.2.3