diff options
| -rw-r--r-- | doc/qtfeedback.qdocconf | 15 | ||||
| -rw-r--r-- | doc/src/plugins/qml-feedback.qdoc | 2 | ||||
| -rw-r--r-- | doc/src/qtfeedback.qdoc | 20 |
3 files changed, 30 insertions, 7 deletions
diff --git a/doc/qtfeedback.qdocconf b/doc/qtfeedback.qdocconf index d1cf628..c37e681 100644 --- a/doc/qtfeedback.qdocconf +++ b/doc/qtfeedback.qdocconf @@ -15,7 +15,7 @@ include(qt-defines.qdocconf) # Images should be placed in <rootdir>/dic/images and examples in # <rootdir>/examples. # Paths are relative to the location of this file. -exampledirs += src/snippets .. +exampledirs += src/snippets .. ../examples headerdirs += .. imagedirs += src/images sourcedirs += .. @@ -41,17 +41,22 @@ qhp.qtfeedback.namespace = com.nokia.mp.qtfeedback.100 # Title for the package, will be the main title for the package in # Assistant/Creator. -qhp.qtfeedback.indexTitle = Qt Feedback Documentation +qhp.qtfeedback.indexTitle = Qt Feedback # Extra files to add to the output which are not linked to from anywhere # using a qdoc \l command. qhp.qtfeedback.extraFiles = style/style.css \ - index.html + qtfeedback-index.html # Only updtae the name of the project for the next variables. qhp.qtfeedback.virtualFolder = qdoc -qhp.qtfeedback.subprojects = classes -qhp.qtfeedback.subprojects.classes.title = Classes +qhp.qtfeedback.subprojects = qmltypes classes +qhp.qtfeedback.subprojects.qmltypes.title = QML Types +qhp.qtfeedback.subprojects.qmltypes.indexTitle = Qt Feedback QML Types +qhp.qtfeedback.subprojects.qmltypes.selectors = qmlclass +qhp.qtfeedback.subprojects.qmltypes.sortPages = true +qhp.qtfeedback.subprojects.classes.title = C++ Classes +qhp.qtfeedback.subprojects.classes.indexTitle = Qt Feedback C++ Classes qhp.qtfeedback.subprojects.classes.selectors = class fake:headerfile qhp.qtfeedback.subprojects.classes.sortPages = true diff --git a/doc/src/plugins/qml-feedback.qdoc b/doc/src/plugins/qml-feedback.qdoc index dfacd75..0d75c9b 100644 --- a/doc/src/plugins/qml-feedback.qdoc +++ b/doc/src/plugins/qml-feedback.qdoc @@ -36,7 +36,7 @@ /*! \page qml-feedback-api.html - \title QML Feedback API + \title Qt Feedback QML Types \brief A QML plugin for the QtFeedback API. diff --git a/doc/src/qtfeedback.qdoc b/doc/src/qtfeedback.qdoc index 9ee13a1..860f9d1 100644 --- a/doc/src/qtfeedback.qdoc +++ b/doc/src/qtfeedback.qdoc @@ -28,7 +28,7 @@ /*! \page qtfeedback-index.html -\title C++ Feedback API +\title Qt Feedback \brief An API enabling a client to provide tactile and audio feedback to user actions. @@ -197,3 +197,21 @@ application. */ +/*! + \page feedback-api.html + + \title Qt Feedback C++ Classes + + \brief An API enabling a client to provide tactile and audio feedback to user actions. + + \section1 Overview + + The C++ Feedback API enables a client to control and provide tactile and audio feedback + to the user. The feedback is in response to user actions. For example, touching an + onscreen button. Control of the feedback involves control of the vibration of + the device, when a vibrator is used, or the piezo feedback from the screen. + + \section1 Feedback C++ Classes + + \annotatedlist feedback +*/ |