summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorkh1 <karsten.heimrich@digia.com>2014-10-07 15:05:08 +0200
committerKarsten Heimrich <karsten.heimrich@digia.com>2014-10-08 16:36:21 +0200
commit8ea9ccf39b47c57b432786b4b2fb135f56e53dde (patch)
tree82d0006dfd83b0ab6d8deb3385b83200164061dc /doc
parent241141938dc07bb3915d48eebf2f56c13261edeb (diff)
Fix c++ documentation creation. Add, fix inline documentation.
Change-Id: Idd6805afbf5736eebf03c2d1ca6dae272c519634 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/installerfw-cpp-classes.qdoc6
-rw-r--r--doc/installerfw.qdoc1
-rw-r--r--doc/installerfw.qdocconf15
-rw-r--r--doc/scripting-qmlmodule.qdoc35
4 files changed, 50 insertions, 7 deletions
diff --git a/doc/installerfw-cpp-classes.qdoc b/doc/installerfw-cpp-classes.qdoc
index 00cef4918..726ced3e3 100644
--- a/doc/installerfw-cpp-classes.qdoc
+++ b/doc/installerfw-cpp-classes.qdoc
@@ -27,12 +27,12 @@
/*!
\contentspage {index.html}{Qt Installer Framework}
- \previouspage ifw-tools.html
+ \previouspage scripting-qmlmodule.html
\page ifw-cpp-classes.html
\nextpage ifw-knownissues.html
\title C++ Classes
- \generatelist annotatedclasses
-
+ \generatelist{classesbymodule QtInstallerFramework}
+ \generatelist{classesbymodule kdupdater}
*/
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 025bfb431..502631acb 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -75,6 +75,7 @@
\li \l{Component Scripting}
\li \l{Operations}
\li \l{Tools}
+ \li \l{Scripting}
\li \l{C++ Classes}
\endlist
\li \l{Known Issues}
diff --git a/doc/installerfw.qdocconf b/doc/installerfw.qdocconf
index 728500d13..4bb83b0f1 100644
--- a/doc/installerfw.qdocconf
+++ b/doc/installerfw.qdocconf
@@ -4,23 +4,30 @@ include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
include($QT_INSTALL_DOCS/global/compat.qdocconf)
include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
+language = Cpp
project = "Qt Installer Framework"
description = "Qt Installer Framework Manual"
url = http://qt-project.org/doc/qtinstallerframework/
-headerdirs = ../src/libs/installer
-sourcedirs = ../src/libs/installer \
- includes
+sourcedirs += includes
+sourcedirs += ../src/libs/installer ../src/libs/kdtools
+headerdirs += ../src/libs/installer ../src/libs/kdtools
imagedirs = $SRCDIR/images $SRCDIR/templates/images
outputdir = $OUTDIR
exampledirs = $SRCDIR ../examples
+headers.fileextensions = "*.h"
sources.fileextensions = "*.qdoc *.qdocinc *.cpp"
examples.fileextensions = "*.js *.qs *.txt *.xml"
examples.imageextensions = "*.png"
-indexes = $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index
+indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
+ $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
+ $QT_INSTALL_DOCS/qtqml/qtqml.index \
+ $QT_INSTALL_DOCS/qtxml/qtxml.index \
+ $QT_INSTALL_DOCS/qtconcurrent/qtconcurrent.index \
+ $QT_INSTALL_DOCS/qtnetwork/qtnetwork.index
qhp.projects = InstallerFramework
qhp.InstallerFramework.file = ifw.qhp
diff --git a/doc/scripting-qmlmodule.qdoc b/doc/scripting-qmlmodule.qdoc
new file mode 100644
index 000000000..f785d28d2
--- /dev/null
+++ b/doc/scripting-qmlmodule.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Installer Framework.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+ \contentspage {index.html}{Qt Installer Framework}
+ \previouspage ifw-tools.html
+ \nextpage ifw-cpp-classes.html
+
+ \title Scripting
+ \qmlmodule scripting
+*/