qiurui
/
qtfeedback
mirror of https://github.com/qt/qtfeedback.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix QDoc configuration 

Issues fixed
- Problem with linking examples
- Index page not found
- No QML Types node in TOC
- No index page for C++ Classes node

Change-Id: Ifb849008fb5329e2e66598848fde41cd64b0ec46
Reviewed-by: Pekka Vuorela <pvuorela@iki.fi>
This commit is contained in:
Martin Kampas 2018-03-29 11:08:53 +02:00 committed by Martin Kampas
parent ee2387fef8
commit 4b552545fd
3 changed files with 30 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/qtfeedback.qdocconf
View File

@ -15,7 +15,7 @@ include(qt-defines.qdocconf)
# Images should be placed in <rootdir>/dic/images and examples in # Images should be placed in <rootdir>/dic/images and examples in
# <rootdir>/examples. # <rootdir>/examples.
# Paths are relative to the location of this file. # Paths are relative to the location of this file.
exampledirs += src/snippets .. exampledirs += src/snippets .. ../examples
headerdirs += .. headerdirs += ..
imagedirs += src/images imagedirs += src/images
sourcedirs += .. 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 # Title for the package, will be the main title for the package in
# Assistant/Creator. # 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 # Extra files to add to the output which are not linked to from anywhere
# using a qdoc \l command. # using a qdoc \l command.
qhp.qtfeedback.extraFiles = style/style.css \ qhp.qtfeedback.extraFiles = style/style.css \
index.html qtfeedback-index.html
# Only updtae the name of the project for the next variables. # Only updtae the name of the project for the next variables.
qhp.qtfeedback.virtualFolder = qdoc qhp.qtfeedback.virtualFolder = qdoc
qhp.qtfeedback.subprojects = classes qhp.qtfeedback.subprojects = qmltypes classes
qhp.qtfeedback.subprojects.classes.title = 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.selectors = class fake:headerfile
qhp.qtfeedback.subprojects.classes.sortPages = true qhp.qtfeedback.subprojects.classes.sortPages = true

2
doc/src/plugins/qml-feedback.qdoc
View File

@ -36,7 +36,7 @@
/*! /*!
\page qml-feedback-api.html \page qml-feedback-api.html
\title QML Feedback API \title Qt Feedback QML Types
\brief A QML plugin for the QtFeedback API. \brief A QML plugin for the QtFeedback API.

20
doc/src/qtfeedback.qdoc
View File

@ -28,7 +28,7 @@
/*! /*!
\page qtfeedback-index.html \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. \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
*/