From f810c9fc330e41230321442e3fa06edb2fd95ee6 Mon Sep 17 00:00:00 2001 From: Lars Knoll Date: Thu, 29 Nov 2012 12:14:07 +0100 Subject: [PATCH] Fixes to Qt D-Bus docs Change-Id: Ib13dc69edce9b989915e4eb75421e775b173095b Reviewed-by: Paul Olav Tvete --- src/dbus/doc/qtdbus.qdocconf | 73 ++++++++++--------- src/dbus/doc/src/qtdbus-index.qdoc | 2 - .../src/{qtdbus.qdoc => qtdbus-module.qdoc} | 11 +-- .../doc/src/qtprintsupport-index.qdoc | 5 +- 4 files changed, 48 insertions(+), 43 deletions(-) rename src/dbus/doc/src/{qtdbus.qdoc => qtdbus-module.qdoc} (98%) 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 - -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 - -tagfile = ../../../doc/qtdbus/qtdbus.tags - -depends += qtcore - -headerdirs += .. - -sourcedirs += .. +# 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 /dic/images and examples in +# /examples. +# Paths are relative to the location of this file. exampledirs += ../../../examples/dbus \ - ../ \ snippets +headerdirs += .. +imagedirs += images +sourcedirs += .. excludedirs += ../../../examples/widgets/doc -imagedirs += images +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. + +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp..property +# format. +qhp.projects = qtdbus + +# Sets the name of the output qhp file. +qhp.qtdbus.file = qtdbus.qhp + +# 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 + +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.qtdbus.indexTitle = Qt Script Documentation + +# 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 diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc index b2fb522867..803a062255 100644 --- a/src/dbus/doc/src/qtdbus-index.qdoc +++ b/src/dbus/doc/src/qtdbus-index.qdoc @@ -213,6 +213,4 @@ \li \l{QtDBus XML compiler (qdbusxml2cpp)} \li \l{Qt D-Bus C++ Classes} \endlist - - \endlist */ diff --git a/src/dbus/doc/src/qtdbus.qdoc b/src/dbus/doc/src/qtdbus-module.qdoc similarity index 98% rename from src/dbus/doc/src/qtdbus.qdoc rename to src/dbus/doc/src/qtdbus-module.qdoc index ba6af143a8..08f0785489 100644 --- a/src/dbus/doc/src/qtdbus.qdoc +++ b/src/dbus/doc/src/qtdbus-module.qdoc @@ -28,14 +28,15 @@ /*! \module QtDBus \title Qt D-Bus C++ Classes - \ingroup modules - - \keyword QtDBus - \target The QDBus compiler - \brief The QtDBus module is a Unix-only library that you can use to perform Inter-Process Communication using the \l{D-Bus} protocol. + \ingroup modules + \ingroup technology-apis + + \target The QDBus compiler + + Applications using the QtDBus module can provide services to other, remote applications by exporting objects, as well as use services exported by those applications by placing calls and diff --git a/src/printsupport/doc/src/qtprintsupport-index.qdoc b/src/printsupport/doc/src/qtprintsupport-index.qdoc index 414ad570d8..be7d70a2b2 100644 --- a/src/printsupport/doc/src/qtprintsupport-index.qdoc +++ b/src/printsupport/doc/src/qtprintsupport-index.qdoc @@ -28,9 +28,10 @@ /*! \page qtprintsupport-index.html \title Qt Print Support - \ingroup qt-graphics - \brief A guide to producing printed output with Qt's paint system and widgets. + \ingroup qt-graphics + \ingroup technology-apis + Qt provides extensive cross-platform support for printing. Using the printing systems on each platform, Qt applications can print to attached printers and