Commit a565b4c8 authored by Frederik Gladhorn's avatar Frederik Gladhorn Committed by Mitch Curtis
Browse files

Fix documentation to list cpp classes and qml types


Change-Id: Ic3528e5de45871818e105cde5ab6b5465db09623
Reviewed-by: default avatarMitch Curtis <mitch.curtis@digia.com>
Showing with 45 additions and 15 deletions
......@@ -21,7 +21,7 @@
/*!
\class AbstractInputMethod
\inmodule InputFramework
\inmodule qtvirtualkeyboard
\brief The base class for input methods.
......
......@@ -21,7 +21,7 @@
/*!
\class AbstractInputPanel
\inmodule InputFramework
\inmodule qtvirtualkeyboard
\brief Base class for an input panel.
......
......@@ -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.
*/
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -29,6 +29,7 @@ public:
/*!
\qmltype ShiftHandler
\inqmlmodule QtQuick.Enterprise.VirtualKeyboard 1.0
\ingroup qtvirtualkeyboard-qml
\instantiates DeclarativeShiftHandler
\brief Manages the shift state.
*/
......
......@@ -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
......@@ -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
*/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment