summaryrefslogtreecommitdiffstats
path: root/src/core/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/doc')
-rw-r--r--src/core/doc/qt3dcore.qdocconf17
-rw-r--r--src/core/doc/src/qt3dcore-index.qdoc1
-rw-r--r--src/core/doc/src/qt3dcore-module.qdoc14
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
+*/