diff options
author | Frederik Gladhorn <frederik.gladhorn@digia.com> | 2014-01-28 14:28:35 +0100 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@digia.com> | 2014-01-28 15:49:08 +0200 |
commit | a565b4c847f390a9563b0649b8b8e47e586cd0d7 (patch) | |
tree | 8679b02e99b4ba7e9cfe0b2d8ed63c452ab7eb3b /src/virtualkeyboard | |
parent | 6b9bfc2ef597cb7de7f937ac90e7b3cfc98bb60d (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')
-rw-r--r-- | src/virtualkeyboard/abstractinputmethod.cpp | 2 | ||||
-rw-r--r-- | src/virtualkeyboard/abstractinputpanel.cpp | 2 | ||||
-rw-r--r-- | src/virtualkeyboard/declarativeinputcontext.cpp | 2 | ||||
-rw-r--r-- | src/virtualkeyboard/declarativeinputengine.cpp | 1 | ||||
-rw-r--r-- | src/virtualkeyboard/declarativeinputmethod.cpp | 1 | ||||
-rw-r--r-- | src/virtualkeyboard/declarativeselectionlistmodel.cpp | 1 | ||||
-rw-r--r-- | src/virtualkeyboard/declarativeshifthandler.cpp | 1 | ||||
-rw-r--r-- | src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf | 24 | ||||
-rw-r--r-- | src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc | 26 |
9 files changed, 45 insertions, 15 deletions
diff --git a/src/virtualkeyboard/abstractinputmethod.cpp b/src/virtualkeyboard/abstractinputmethod.cpp index ca5e02e4..edf91894 100644 --- a/src/virtualkeyboard/abstractinputmethod.cpp +++ b/src/virtualkeyboard/abstractinputmethod.cpp @@ -21,7 +21,7 @@ /*! \class AbstractInputMethod - \inmodule InputFramework + \inmodule qtvirtualkeyboard \brief The base class for input methods. diff --git a/src/virtualkeyboard/abstractinputpanel.cpp b/src/virtualkeyboard/abstractinputpanel.cpp index da77a975..56230b85 100644 --- a/src/virtualkeyboard/abstractinputpanel.cpp +++ b/src/virtualkeyboard/abstractinputpanel.cpp @@ -21,7 +21,7 @@ /*! \class AbstractInputPanel - \inmodule InputFramework + \inmodule qtvirtualkeyboard \brief Base class for an input panel. diff --git a/src/virtualkeyboard/declarativeinputcontext.cpp b/src/virtualkeyboard/declarativeinputcontext.cpp index c7b2bbad..b5edfe03 100644 --- a/src/virtualkeyboard/declarativeinputcontext.cpp +++ b/src/virtualkeyboard/declarativeinputcontext.cpp @@ -63,6 +63,7 @@ public: \qmltype InputContext \instantiates DeclarativeInputContext \inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0 + \ingroup qtvirtualkeyboard-qml \brief Provides access to an input context. The InputContext can be accessed as singleton instance. @@ -71,6 +72,7 @@ public: /*! \class DeclarativeInputContext \inmodule InputFramework + \ingroup qtvirtualkeyboard-qml \brief Provides access to an input context. */ diff --git a/src/virtualkeyboard/declarativeinputengine.cpp b/src/virtualkeyboard/declarativeinputengine.cpp index 548543c6..521d3a45 100644 --- a/src/virtualkeyboard/declarativeinputengine.cpp +++ b/src/virtualkeyboard/declarativeinputengine.cpp @@ -64,6 +64,7 @@ private: /*! \qmltype InputEngine \inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0 + \ingroup qtvirtualkeyboard-qml \instantiates DeclarativeInputEngine \brief Maps the user input to the input methods. diff --git a/src/virtualkeyboard/declarativeinputmethod.cpp b/src/virtualkeyboard/declarativeinputmethod.cpp index 980d25d3..e504818f 100644 --- a/src/virtualkeyboard/declarativeinputmethod.cpp +++ b/src/virtualkeyboard/declarativeinputmethod.cpp @@ -23,6 +23,7 @@ \qmltype InputMethod \instantiates DeclarativeInputMethod \inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0 + \ingroup qtvirtualkeyboard-qml \brief Base type for creating input method in QML. The InputMethod type lets you create a custom input method diff --git a/src/virtualkeyboard/declarativeselectionlistmodel.cpp b/src/virtualkeyboard/declarativeselectionlistmodel.cpp index e0ef1f05..1c5a14f5 100644 --- a/src/virtualkeyboard/declarativeselectionlistmodel.cpp +++ b/src/virtualkeyboard/declarativeselectionlistmodel.cpp @@ -32,6 +32,7 @@ public: \qmltype SelectionListModel \instantiates DeclarativeSelectionListModel \inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0 + \ingroup qtvirtualkeyboard-qml \brief Provides a data model for the selection lists. This type acts as a bridge between the UI and the diff --git a/src/virtualkeyboard/declarativeshifthandler.cpp b/src/virtualkeyboard/declarativeshifthandler.cpp index d7ce7048..25c40a3f 100644 --- a/src/virtualkeyboard/declarativeshifthandler.cpp +++ b/src/virtualkeyboard/declarativeshifthandler.cpp @@ -29,6 +29,7 @@ public: /*! \qmltype ShiftHandler \inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0 + \ingroup qtvirtualkeyboard-qml \instantiates DeclarativeShiftHandler \brief Manages the shift state. */ 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 +*/ |