diff options
| author | Milian Wolff <milian.wolff@kdab.com> | 2014-07-16 17:39:31 +0200 |
|---|---|---|
| committer | Sumedha Widyadharma <sumedha.widyadharma@basyskom.com> | 2014-08-01 09:16:16 +0200 |
| commit | b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860 (patch) | |
| tree | 9687c3b47f4e77e931916a8afe1d516d3b280101 /src/webchannel/doc/qtwebchannel.qdocconf | |
| parent | 5051411b92b4aca4ed5ec462e7b0e52af4d3951e (diff) | |
| download | qtwebchannel-b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860.tar.gz | |
Add documentation for the QtWebChannel module.
Please proof-read it and tell me what needs to be improved. I assume
most people will probably not use the QWebChannel directly. Rather, they
will only consume its features indirectly through the integration in
QtWebKit/QtWebEngine. Thus the documentation here is for QWebChannel as
a library. User-end documentation should be added to QtWebKit, I think.
Change-Id: I259c204e24331271b8dc74ea11695988234a79d3
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/webchannel/doc/qtwebchannel.qdocconf')
| -rw-r--r-- | src/webchannel/doc/qtwebchannel.qdocconf | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/src/webchannel/doc/qtwebchannel.qdocconf b/src/webchannel/doc/qtwebchannel.qdocconf new file mode 100644 index 0000000..e2ed336 --- /dev/null +++ b/src/webchannel/doc/qtwebchannel.qdocconf @@ -0,0 +1,56 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtWebChannel +description = Qt WebChannel Reference Documentation +version = $QT_VERSION + +examplesinstallpath = webchannel + +qhp.projects = QtWebChannel + +qhp.QtWebChannel.file = qtwebchannel.qhp +qhp.QtWebChannel.namespace = org.qt-project.qtwebchannel.$QT_VERSION_TAG +qhp.QtWebChannel.virtualFolder = qtwebchannel +qhp.QtWebChannel.indexTitle = Qt WebChannel +qhp.QtWebChannel.indexRoot = + +qhp.QtWebChannel.filterAttributes = qtwebchannel $QT_VERSION qtrefdoc +qhp.QtWebChannel.customFilters.Qt.name = QtWebChannel $QT_VERSION +qhp.QtWebChannel.customFilters.Qt.filterAttributes = qtwebchannel $QT_VERSION + +qhp.QtWebChannel.subprojects = classes qml examples javascript + +qhp.QtWebChannel.subprojects.classes.title = C++ Classes +qhp.QtWebChannel.subprojects.classes.indexTitle = Qt WebChannel C++ Classes +qhp.QtWebChannel.subprojects.classes.selectors = class fake:headerfile +qhp.QtWebChannel.subprojects.classes.sortPages = true + +qhp.QtWebChannel.subprojects.qml.title = QML Types +qhp.QtWebChannel.subprojects.qml.indexTitle = Qt WebChannel QML Types +qhp.QtWebChannel.subprojects.qml.selectors = qmlclass +qhp.QtWebChannel.subprojects.qml.sortPages = true + +qhp.QtWebChannel.subprojects.examples.title = Examples +qhp.QtWebChannel.subprojects.examples.indexTitle = Qt WebChannel Examples +qhp.QtWebChannel.subprojects.examples.selectors = fake:example +qhp.QtWebChannel.subprojects.examples.sortPages = true + +qhp.QtWebChannel.subprojects.javascript.title = JavaScript API +qhp.QtWebChannel.subprojects.javascript.indexTitle = Qt WebChannel JavaScript API + +tagfile = ../../../doc/qtwebchannel/qtwebchannel.tags + +depends += qtcore qtquick qtqml qmake + +headerdirs += .. \ + ../../imports + +sourcedirs += .. \ + ../../imports + + +exampledirs += ../../../examples/webchannel + +navigation.landingpage = "Qt WebChannel" +navigation.cppclassespage = "Qt WebChannel C++ Classes" +navigation.qmltypespage = "Qt WebChannel QML Types" |