aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2014-01-28 14:28:35 +0100
committerMitch Curtis <mitch.curtis@digia.com>2014-01-28 15:49:08 +0200
commita565b4c847f390a9563b0649b8b8e47e586cd0d7 (patch)
tree8679b02e99b4ba7e9cfe0b2d8ed63c452ab7eb3b /src/virtualkeyboard/doc
parent6b9bfc2ef597cb7de7f937ac90e7b3cfc98bb60d (diff)
Fix documentation to list cpp classes and qml types
Change-Id: Ic3528e5de45871818e105cde5ab6b5465db09623 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
Diffstat (limited to 'src/virtualkeyboard/doc')
-rw-r--r--src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf24
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc26
2 files changed, 37 insertions, 13 deletions
diff --git a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
index 95928c6e..eee4d3f3 100644
--- a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
+++ b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
@@ -16,7 +16,9 @@ exampledirs += ../../../examples/quick/enterprise/virtualkeyboard \
examplesinstallpath = quick/enterprise/virtualkeyboard
imagedirs += images
-spurious = "Can't link to 'All Modules'"
+depends += qtcore qtgui qtquick
+
+# spurious = "Can't link to 'All Modules'"
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
@@ -36,9 +38,19 @@ qhp.QtVirtualKeyboard.filterAttributes = qtvirtualkeyboard 1.0
qhp.QtVirtualKeyboard.customFilters.Qt.name = QtVirtualKeyboard 1.0
qhp.QtVirtualKeyboard.customFilters.Qt.filterAttributes = qtvirtualkeyboard 1.0
-#qhp.QtVirtualKeyboard.subprojects = qtvirtualkeyboardqmltypes
+qhp.QtVirtualKeyboard.subprojects = classes qmltypes examples
+
+qhp.QtVirtualKeyboard.subprojects.classes.title = C++ Classes
+qhp.QtVirtualKeyboard.subprojects.classes.indexTitle = Qt Virtual Keyboard C++ Classes
+qhp.QtVirtualKeyboard.subprojects.classes.selectors = class
+qhp.QtVirtualKeyboard.subprojects.classes.sortPages = true
+
+qhp.QtVirtualKeyboard.subprojects.qmltypes.title = QML Types
+qhp.QtVirtualKeyboard.subprojects.qmltypes.indexTitle = Qt Virtual Keyboard QML Types
+qhp.QtVirtualKeyboard.subprojects.qmltypes.selectors = fake:qmlclass
+qhp.QtVirtualKeyboard.subprojects.qmltypes.sortPages = true
-#qhp.QtVirtualKeyboard.subprojects.qtvirtualkeyboardqmltypes.title = Controls QML Types
-#qhp.QtVirtualKeyboard.subprojects.qtvirtualkeyboardqmltypes.indexTitle = Qt Virtual Keyboard QML Types
-#qhp.QtVirtualKeyboard.subprojects.qtvirtualkeyboardqmltypes.selectors = fake:qmlclass # cannot choose qmltypes from a specific group QTBUG-32985
-#qhp.QtVirtualKeyboard.subprojects.qtvirtualkeyboardqmltypes.sortPages = true
+qhp.QtVirtualKeyboard.subprojects.examples.title = Examples
+qhp.QtVirtualKeyboard.subprojects.examples.indexTitle = Qt Virtual Keyboard Examples
+qhp.QtVirtualKeyboard.subprojects.examples.selectors = fake:example
+qhp.QtVirtualKeyboard.subprojects.examples.sortPages = true
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 62851427..044de718 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -17,7 +17,7 @@
****************************************************************************/
/*!
- \title QtVKB Reference
+ \title Qt Virtual Keyboard
\page index.html
The QtVKB project provides an input framework and reference
@@ -35,17 +35,13 @@
\li \l {Technical Guide}
\endlist
- \section1 Modules
-
- \generatelist module
-
\section1 C++ Classes
- \generatelist annotatedclasses
+ \generatelist {classesbymodule qtvirtualkeyboard}
\section1 QML Elements
- \generatelist qmltypes
+ \annotatedlist qtvirtualkeyboard-qml
\section1 Examples
@@ -53,3 +49,19 @@
\li \l{Qt Virtual Keyboard Examples}
\endlist
*/
+
+/*!
+\page qt-virtual-keyboard-classes.html
+\title Qt Virtual Keyboard C++ Classes
+\inmodule qtvirtualkeyboard
+
+\generatelist {classesbymodule qtvirtualkeyboard}
+*/
+
+/*!
+\page qt-virtual-keyboard-qmltypes.html
+\title Qt Virtual Keyboard QML Types
+\inmodule qtvirtualkeyboard
+
+\annotatedlist qtvirtualkeyboard-qml
+*/