diff options
author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2015-10-22 15:40:21 +0200 |
---|---|---|
committer | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2015-10-27 13:21:59 +0000 |
commit | d954056627d34907eeee6bba10ddf2e792d90140 (patch) | |
tree | 7d446091c193011540eb044b2d89bfed3c15d224 /src/core/doc | |
parent | 31a4c1e3438bc47ac9d488f557f6144f0a7463ba (diff) |
Doc: Updated the docs for the namespace changes
Each of the submodules now have there own namespace
so the following changes are required to adapt:
- Added \namespace docs for the new namespaces.
- Updated all the \class and \instantiates entries to use
the appropriate namespace qualifier.
- Changed the \module and \qmlmodule names for Qt 3D Core
and Qt 3D Render modules.
- Added the missing \module and \qmlmodule pages for the
Qt 3D Collision module.
Change-Id: Ibc5bf30e4f50aecb6a3b24bc8536f17ed19d681d
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/core/doc')
-rw-r--r-- | src/core/doc/qt3d.qdocconf | 2 | ||||
-rw-r--r-- | src/core/doc/src/qt3d-index.qdoc | 4 | ||||
-rw-r--r-- | src/core/doc/src/qt3d-module.qdoc | 16 | ||||
-rw-r--r-- | src/core/doc/src/qt3dinput-module.qdoc | 8 |
4 files changed, 20 insertions, 10 deletions
diff --git a/src/core/doc/qt3d.qdocconf b/src/core/doc/qt3d.qdocconf index 7194844be..d58373c27 100644 --- a/src/core/doc/qt3d.qdocconf +++ b/src/core/doc/qt3d.qdocconf @@ -54,6 +54,8 @@ sourcedirs += .. \ exampledirs += ../../../examples/qt3d \ src/snippets +examplesinstallpath = qt3d + examples.fileextensions += "*.fraq *.geom *.vert" examples.imageextensions += "*.png" diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/core/doc/src/qt3d-index.qdoc index 03f3217d3..db8785436 100644 --- a/src/core/doc/src/qt3d-index.qdoc +++ b/src/core/doc/src/qt3d-index.qdoc @@ -60,7 +60,7 @@ \l qmake \c .pro file: \badcode - QT += 3dcore 3drenderer 3dinput 3dcollision 3dlogic + QT += 3dcore 3drender 3dinput 3dcollision 3dlogic \endcode To include the definitions of the modules' classes, use the following @@ -68,7 +68,7 @@ \badcode #include <Qt3DCore> - #include <Qt3DRenderer> + #include <Qt3DRender> #include <Qt3DInput> #include <Qt3DCollision> #include <Qt3DLogic> diff --git a/src/core/doc/src/qt3d-module.qdoc b/src/core/doc/src/qt3d-module.qdoc index e20c8b117..bc9042b46 100644 --- a/src/core/doc/src/qt3d-module.qdoc +++ b/src/core/doc/src/qt3d-module.qdoc @@ -72,12 +72,12 @@ \section2 Qt 3D Logic Module \generatelist {classesbymodule Qt3DLogic} - \section2 Qt 3D Renderer Module - \generatelist {classesbymodule Qt3DRenderer} + \section2 Qt 3D Render Module + \generatelist {classesbymodule Qt3DRender} */ /*! - \namespace Qt3D + \namespace Qt3DCore \inmodule Qt3DCore \ingroup qt3d-namespaces @@ -87,7 +87,7 @@ */ /*! - \qmlmodule Qt3D 2.0 + \qmlmodule Qt3D.Core 2.0 \title Qt 3D QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules @@ -97,7 +97,7 @@ To import and use the module's QML types, use the following statement: \badcode - import Qt3D 2.0 + import Qt3D.Core 2.0 \endcode For collision detection, renderer, and input-related QML types, use the @@ -105,7 +105,7 @@ \badcode import Qt3D.Collision 2.0 - import Qt3D.Renderer 2.0 + import Qt3D.Render 2.0 import Qt3D.Input 2.0 import Qt3D.Logic 2.0 \endcode @@ -124,7 +124,7 @@ \section2 Qt 3D Logic Module \generatelist {qmltypesbymodule Qt3D.Logic} - \section2 Qt 3D Renderer Module - \generatelist {qmltypesbymodule Qt3D.Renderer} + \section2 Qt 3D Render Module + \generatelist {qmltypesbymodule Qt3D.Render} \noautolist */ diff --git a/src/core/doc/src/qt3dinput-module.qdoc b/src/core/doc/src/qt3dinput-module.qdoc index b82de6862..c46d577dd 100644 --- a/src/core/doc/src/qt3dinput-module.qdoc +++ b/src/core/doc/src/qt3dinput-module.qdoc @@ -49,6 +49,14 @@ */ /*! + \namespace Qt3DInput + \inmodule Qt3DInput + \ingroup qt3d-namespaces + + \brief Contains classes that enable user input. +*/ + +/*! \qmlmodule Qt3D.Input 2.0 \title Qt3D Input QML Types \ingroup qmlmodules |