diff options
Diffstat (limited to 'src/core')
-rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 4 | ||||
-rw-r--r-- | src/core/doc/src/qt3dcore-index.qdoc | 15 | ||||
-rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 5 |
3 files changed, 16 insertions, 8 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index 65e6e03fe..28f985029 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -11,7 +11,7 @@ qhp.projects = Qt3DCore qhp.Qt3DCore.file = qt3dcore.qhp qhp.Qt3DCore.namespace = org.qt-project.qt3dcore.$QT_VERSION_TAG qhp.Qt3DCore.virtualFolder = qt3dcore -qhp.Qt3DCore.indexTitle = Qt3D Core +qhp.Qt3DCore.indexTitle = Qt3D Module qhp.Qt3DCore.indexRoot = qhp.Qt3DCore.filterAttributes = qt3dcore $QT_VERSION qtrefdoc @@ -56,6 +56,6 @@ Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \ Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY -navigation.landingpage = "Qt3D Core" +navigation.landingpage = "Qt3D Module" 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 ec8c6c1b7..5c3bc9794 100644 --- a/src/core/doc/src/qt3dcore-index.qdoc +++ b/src/core/doc/src/qt3dcore-index.qdoc @@ -36,18 +36,22 @@ ****************************************************************************/ /*! - \page qt3dcore-index.html + \page qt3d-index.html \title Qt3D Module \e Qt3D provides functionality for near-realtime simulation systems with support for 2D and 3D rendering in both Qt C++ and Qt Quick applications. - The functionality in Qt3D is divided into the following modules: + The functionality in Qt3D is divided into the following C++ modules: \annotatedlist qt3d-modules - Classes, types and functions are declared under the \l Qt3D namespace. + Classes, types and functions are declared under the \l [CPP] {Qt3D} namespace. + + For Qt Quick applications, Qt3D provides the following QML modules: + + \annotatedlist qt3d-qmlmodules \section1 Getting Started @@ -80,9 +84,8 @@ \section1 Reference \list - \li \l {Qt3D}{Qt3D namespace} - \li \l {Qt3D Core C++ Classes} - \li \l {Qt3D Render C++ Classes} + \li \l {Qt3D Overview} + \li \l [CPP] {Qt3D}{Qt3D Namespace} \li \l {Qt3D Examples} \endlist diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index d664b8bf6..e04c61737 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -40,6 +40,7 @@ \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. \ingroup modules + \ingroup qt3d-modules \qtvariable 3dcore The Qt3D Core module provides the foundations and core types used for near-realtime @@ -49,6 +50,7 @@ /*! \namespace Qt3D \inmodule Qt3DCore + \ingroup qt3d-namespaces \brief Contains classes and types that are the foundation of the Qt3D simulation framework, as well as classes that provide the ability to render using the Qt3D @@ -59,6 +61,7 @@ \qmlmodule Qt3D 2.0 \title Qt3D Core QML Types \ingroup qmlmodules + \ingroup qt3d-qmlmodules \brief Provides core Qt3D QML types. @@ -67,4 +70,6 @@ \badcode import Qt3D 2.0 \endcode + + \section1 QML Types */ |