diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-04-28 13:05:39 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-04-29 07:33:44 +0000 |
| commit | 2d5f95bacf7722b2546f6c40e4ce236c75ae379d (patch) | |
| tree | 1145523e70914a1990a58c4ce0fedfedfb1a0805 /src/core/doc | |
| parent | 21c9dfef8bf81f7a1910d5d07baf9fdab39750a4 (diff) | |
Doc: Add Qt3D QML module and QML type documentation skeletonv5.5.0-beta1
Add documentation structure and comment blocks containing \qmltype,
\qmlproperty, etc. commands for Qt3D QML module.
The actual documentation (descriptions) are still missing, but this
allows the QML type documentation to be generated.
Change-Id: Id0e1afc89c13d963c950c142a3407aa70702562f
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/core/doc')
| -rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 17 | ||||
| -rw-r--r-- | src/core/doc/src/qt3dcore-index.qdoc | 1 | ||||
| -rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 14 |
3 files changed, 29 insertions, 3 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index 02907b173..db2848ae8 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -18,20 +18,30 @@ qhp.Qt3DCore.filterAttributes = qt3dcore $QT_VERSION qtrefdoc qhp.Qt3DCore.customFilters.Qt.name = Qt3DCore $QT_VERSION qhp.Qt3DCore.customFilters.Qt.filterAttributes = qt3dcore $QT_VERSION -qhp.Qt3DCore.subprojects = classes +qhp.Qt3DCore.subprojects = classes qmltypes + qhp.Qt3DCore.subprojects.classes.title = C++ Classes qhp.Qt3DCore.subprojects.classes.indexTitle = Qt3D Core C++ Classes qhp.Qt3DCore.subprojects.classes.selectors = class fake:headerfile qhp.Qt3DCore.subprojects.classes.sortPages = true +qhp.Qt3DCore.subprojects.qmltypes.title = QML Types +qhp.Qt3DCore.subprojects.qmltypes.indexTitle = Qt3D Core QML Types +qhp.Qt3DCore.subprojects.qmltypes.selectors = qmlclass +qhp.Qt3DCore.subprojects.qmltypes.sortPages = true + tagfile = ../../../doc/qt3dcore/qt3dcore.tags depends += qtcore qtqml qtquick qtdoc qt3drender headerdirs += .. \ - ../../plugins + ../../plugins \ + ../../quick3d/quick3d + sourcedirs += .. \ - ../../plugins + ../../plugins \ + ../../quick3d/quick3d + exampledirs += src/snippets #excludedirs += @@ -45,3 +55,4 @@ Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY navigation.landingpage = "Qt3D Core" navigation.cppclassespage = "Qt3D Core C++ Classes" +navigation.qmltypespage = "Qt3D Core QML Types" diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc index 184068337..b2908264b 100644 --- a/src/core/doc/src/qt3dcore-index.qdoc +++ b/src/core/doc/src/qt3dcore-index.qdoc @@ -58,6 +58,7 @@ \list \li \l {Qt3D Core C++ Classes} + \li \l {Qt3D Core QML Types} \li \l {Qt3D Examples} \endlist diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 453152d85..d664b8bf6 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -54,3 +54,17 @@ framework, as well as classes that provide the ability to render using the Qt3D framework. */ + +/*! + \qmlmodule Qt3D 2.0 + \title Qt3D Core QML Types + \ingroup qmlmodules + + \brief Provides core Qt3D QML types. + + To import and use the module's QML types, use the following statement: + + \badcode + import Qt3D 2.0 + \endcode +*/ |