diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-06 10:50:22 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-11 10:52:38 +0000 |
| commit | 4b2727c742ff37af82c131e4e4d94045d40ac55a (patch) | |
| tree | 5461b939c7faeee70c85dc516b01cf5249b1c814 /doc | |
| parent | 462bbae2a52219f067e81bf1fe8402be32f648cc (diff) | |
Doc: add links to topics that describe the namespaces
In addition to linking to the classes from the top level
topic. The namespace topics are generated automatically
and list all classes in a namespace with brief descriptions.
Add subtitles for listing the classes in each namespace.
Change-Id: I0304a86717e018fa3af9f213871f159fdb4ce05c
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installerfw-cpp-classes.qdoc | 28 | ||||
| -rw-r--r-- | doc/installerfw-reference.qdoc | 2 | ||||
| -rw-r--r-- | doc/installerfw.qdoc | 2 |
3 files changed, 28 insertions, 4 deletions
diff --git a/doc/installerfw-cpp-classes.qdoc b/doc/installerfw-cpp-classes.qdoc index d1ab8747d..48c914399 100644 --- a/doc/installerfw-cpp-classes.qdoc +++ b/doc/installerfw-cpp-classes.qdoc @@ -31,9 +31,9 @@ \page ifw-cpp-classes.html \nextpage ifw-knownissues.html - \title C++ Classes + \title C++ API - The class documentation is written for developers who develop the Qt + The C++ API documentation is written for developers who develop the Qt Installer Framework. It describes the internal API, so there is no compatibility promise. Further, the documentation is a work in progress and therefore parts of it are missing while other parts might be out of date. @@ -41,6 +41,30 @@ To create customized installers, use the \l{Scripting API}, instead. For more information, see \l {Customizing Installers}. + \section1 Namespaces + + \table + \header + \li Namespace + \li Description + \row + \li \l{qinstaller-module}{QInstaller} + \li Contains classes to implement the core functionality of the Qt + Installer Framework and the installer UI. + \row + \li \l{KDUpdater} + \li Contains classes to automatically detect updates to applications, + to retrieve them from external repositories, and to install them. + KDUpdater classes are a fork of KDAB's general + \l{http://docs.kdab.com/kdtools/2.2.2/group__kdupdater.html} + {KDUpdater module}. + \endtable + + \section1 QInstaller C++ Classes + \generatelist{classesbymodule QtInstallerFramework} + + \section1 KDUpdater C++ Classes + \generatelist{classesbymodule kdupdater} */ diff --git a/doc/installerfw-reference.qdoc b/doc/installerfw-reference.qdoc index 2a243df8c..09a482640 100644 --- a/doc/installerfw-reference.qdoc +++ b/doc/installerfw-reference.qdoc @@ -44,7 +44,7 @@ \li \l{Operations} \li \l{Tools} \li \l{Scripting API} - \li \l{C++ Classes} + \li \l{C++ API} \endlist */ diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index c6ed2b508..ec0fd005b 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -76,7 +76,7 @@ \li \l{Operations} \li \l{Tools} \li \l{Scripting API} - \li \l{C++ Classes} + \li \l{C++ API} \endlist \li \l{Known Issues} \endlist |