summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-22 15:40:21 +0200
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-27 13:21:59 +0000
commitd954056627d34907eeee6bba10ddf2e792d90140 (patch)
tree7d446091c193011540eb044b2d89bfed3c15d224
parent31a4c1e3438bc47ac9d488f557f6144f0a7463ba (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>
-rw-r--r--src/collision/doc/src/qt3dcollision-module.qdoc74
-rw-r--r--src/collision/qabstractcollider.cpp2
-rw-r--r--src/collision/qboxcollider.cpp6
-rw-r--r--src/collision/qcapsulecollider.cpp6
-rw-r--r--src/collision/qcollisionaspect.cpp2
-rw-r--r--src/collision/qspherecollider.cpp6
-rw-r--r--src/core/doc/qt3d.qdocconf2
-rw-r--r--src/core/doc/src/qt3d-index.qdoc4
-rw-r--r--src/core/doc/src/qt3d-module.qdoc16
-rw-r--r--src/core/doc/src/qt3dinput-module.qdoc8
-rw-r--r--src/input/q3dkeyevent.cpp4
-rw-r--r--src/input/q3dmouseevent.cpp4
-rw-r--r--src/input/qkeyboardcontroller.cpp6
-rw-r--r--src/input/qkeyboardinput.cpp6
-rw-r--r--src/input/qmousecontroller.cpp2
-rw-r--r--src/input/qmouseinput.cpp2
-rw-r--r--src/logic/doc/src/qt3dlogic-module.qdoc10
-rw-r--r--src/logic/qlogicaspect.cpp2
-rw-r--r--src/logic/qlogiccomponent.cpp6
-rw-r--r--src/render/defaults/qgoochmaterial.cpp4
-rw-r--r--src/render/defaults/qskyboxentity.cpp4
-rw-r--r--src/render/doc/src/qt3drender-module.qdoc8
-rw-r--r--src/render/framegraph/qcameraselector.cpp2
-rw-r--r--src/render/framegraph/qframegraph.cpp2
-rw-r--r--src/render/framegraph/qframegraphnode.cpp2
-rw-r--r--src/render/framegraph/qlayerfilter.cpp2
-rw-r--r--src/render/framegraph/qnodraw.cpp2
-rw-r--r--src/render/framegraph/qsortcriterion.cpp2
-rw-r--r--src/render/framegraph/qsortmethod.cpp2
-rw-r--r--src/render/framegraph/qstateset.cpp2
-rw-r--r--src/render/frontend/qlayer.cpp2
-rw-r--r--src/render/frontend/qrenderaspect.cpp2
-rw-r--r--src/render/lights/qabstractlight.cpp4
-rw-r--r--src/render/lights/qdirectionallight.cpp2
-rw-r--r--src/render/lights/qpointlight.cpp2
-rw-r--r--src/render/lights/qspotlight.cpp6
-rw-r--r--src/render/materialsystem/qannotation.cpp2
-rw-r--r--src/render/materialsystem/qopenglfilter.cpp2
-rw-r--r--src/render/materialsystem/qparametermapping.cpp2
-rw-r--r--src/render/renderstates/qblendstate.cpp10
-rw-r--r--src/render/renderstates/qclipplane.cpp6
-rw-r--r--src/render/renderstates/qcolormask.cpp2
-rw-r--r--src/render/renderstates/qrenderstate.cpp2
-rw-r--r--src/render/texture/qabstracttextureimage.cpp6
-rw-r--r--src/render/texture/qtextureimage.cpp2
45 files changed, 176 insertions, 76 deletions
diff --git a/src/collision/doc/src/qt3dcollision-module.qdoc b/src/collision/doc/src/qt3dcollision-module.qdoc
new file mode 100644
index 000000000..6c7151128
--- /dev/null
+++ b/src/collision/doc/src/qt3dcollision-module.qdoc
@@ -0,0 +1,74 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \module Qt3DCollision
+ \title Qt3D Collision C++ Classes
+ \brief The Qt3D Collision module enables collision detection.
+ \ingroup modules
+ \ingroup qt3d-modules
+ \qtvariable 3dcollision
+
+ To use classes from this module, add this directive into the C++ files:
+
+ \code
+ #include <Qt3DCollision>
+ \endcode
+
+ To link against the corresponding C++ libraries, add the following to your qmake project file:
+
+ \badcode
+ QT += 3dcollision
+ \endcode
+
+*/
+
+/*!
+ \namespace Qt3DCollision
+ \inmodule Qt3DCollision
+ \ingroup qt3d-namespaces
+
+ \brief Contains classes that enable collision detection.
+*/
+
+/*!
+ \qmlmodule Qt3D.Collision 2.0
+ \title Qt3D Collision QML Types
+ \ingroup qmlmodules
+ \ingroup qt3d-qmlmodules
+
+ \brief Provides QML types to synchronize frames with the 3D backend.
+
+ To import and use the module's QML types, use the following statement:
+
+ \badcode
+ import Qt3D.Collision 2.0
+ \endcode
+
+ \section1 QML Types
+*/
+
diff --git a/src/collision/qabstractcollider.cpp b/src/collision/qabstractcollider.cpp
index 8a549f8a6..f9ed5a943 100644
--- a/src/collision/qabstractcollider.cpp
+++ b/src/collision/qabstractcollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QAbstractColliderPrivate
+ \class Qt3DCollision::QAbstractColliderPrivate
\internal
*/
QAbstractColliderPrivate::QAbstractColliderPrivate()
diff --git a/src/collision/qboxcollider.cpp b/src/collision/qboxcollider.cpp
index abb70908f..a1fa76e21 100644
--- a/src/collision/qboxcollider.cpp
+++ b/src/collision/qboxcollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QBoxColliderPrivate
+ \class Qt3DCollision::QBoxColliderPrivate
\internal
*/
QBoxColliderPrivate::QBoxColliderPrivate()
@@ -53,7 +53,7 @@ QBoxColliderPrivate::QBoxColliderPrivate()
}
/*!
- \class Qt3DCore::QBoxCollider
+ \class Qt3DCollision::QBoxCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a box used for collision detection
@@ -62,7 +62,7 @@ QBoxColliderPrivate::QBoxColliderPrivate()
/*!
\qmltype BoxCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QBoxCollider
+ \instantiates Qt3DCollision::QBoxCollider
\inherits Component3D
\since 5.5
*/
diff --git a/src/collision/qcapsulecollider.cpp b/src/collision/qcapsulecollider.cpp
index 3c1a5f45e..c9aadd33b 100644
--- a/src/collision/qcapsulecollider.cpp
+++ b/src/collision/qcapsulecollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QCapsuleColliderPrivate
+ \class Qt3DCollision::QCapsuleColliderPrivate
\internal
*/
QCapsuleColliderPrivate::QCapsuleColliderPrivate()
@@ -55,7 +55,7 @@ QCapsuleColliderPrivate::QCapsuleColliderPrivate()
}
/*!
- \class Qt3DCore::QCapsuleCollider
+ \class Qt3DCollision::QCapsuleCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a capsule used for collision detection
@@ -64,7 +64,7 @@ QCapsuleColliderPrivate::QCapsuleColliderPrivate()
/*!
\qmltype CapsuleCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QCapsuleCollider
+ \instantiates Qt3DCollision::QCapsuleCollider
\inherits Component3D
\since 5.5
*/
diff --git a/src/collision/qcollisionaspect.cpp b/src/collision/qcollisionaspect.cpp
index 3224d185a..f09a5c1f5 100644
--- a/src/collision/qcollisionaspect.cpp
+++ b/src/collision/qcollisionaspect.cpp
@@ -54,7 +54,7 @@ using namespace Qt3DCore;
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QCollisionAspectPrivate
+ \class Qt3DCollision::QCollisionAspectPrivate
\internal
*/
QCollisionAspectPrivate::QCollisionAspectPrivate()
diff --git a/src/collision/qspherecollider.cpp b/src/collision/qspherecollider.cpp
index 67bcdc1bf..1f038da51 100644
--- a/src/collision/qspherecollider.cpp
+++ b/src/collision/qspherecollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QSphereColliderPrivate
+ \class Qt3DCollision::QSphereColliderPrivate
\internal
*/
QSphereColliderPrivate::QSphereColliderPrivate()
@@ -53,7 +53,7 @@ QSphereColliderPrivate::QSphereColliderPrivate()
}
/*!
- \class Qt3DCore::QSphereCollider
+ \class Qt3DCollision::QSphereCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a sphere used for collision detection
@@ -62,7 +62,7 @@ QSphereColliderPrivate::QSphereColliderPrivate()
/*!
\qmltype SphereCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QSphereCollider
+ \instantiates Qt3DCollision::QSphereCollider
\inherits Component3D
\since 5.5
*/
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
diff --git a/src/input/q3dkeyevent.cpp b/src/input/q3dkeyevent.cpp
index dced98fc0..7c817967b 100644
--- a/src/input/q3dkeyevent.cpp
+++ b/src/input/q3dkeyevent.cpp
@@ -43,7 +43,7 @@ namespace Qt3DInput {
//Qt6: Move this into a QtQmlGui module and merge it with QQuickKeyEvent
/*!
- \class Qt3DCore::Q3DKeyEvent
+ \class Qt3DInput::Q3DKeyEvent
\inmodule Qt3DInput
\since 5.5
*/
@@ -51,7 +51,7 @@ namespace Qt3DInput {
/*!
\qmltype KeyEvent
\inqmlmodule Qt3D.Input
- \instantiates Qt3DCore::Q3DKeyEvent
+ \instantiates Qt3DInput::Q3DKeyEvent
\since 5.5
The KeyEvent QML type cannot be directly created. Objects of this type
diff --git a/src/input/q3dmouseevent.cpp b/src/input/q3dmouseevent.cpp
index 60f8b0784..d880c7585 100644
--- a/src/input/q3dmouseevent.cpp
+++ b/src/input/q3dmouseevent.cpp
@@ -48,7 +48,7 @@ namespace Qt3DInput {
// These can always be added in follow up commits once the input API takes shape
/*!
- * \class Qt3DCore::Q3DMouseEvent
+ * \class Qt3DInput::Q3DMouseEvent
* \inmodule Qt3DInput
*
* \brief The Qt3DCore::Q3DMouseEvent contains parameters that describe a mouse event.
@@ -160,7 +160,7 @@ Q3DMouseEvent::Modifiers Q3DMouseEvent::modifier() const
/*!
- * \class Qt3DCore::Q3DWheelEvent
+ * \class Qt3DInput::Q3DWheelEvent
* \inmodule Qt3DInput
*
* \brief The Qt3DCore::Q3DWheelEvent contains parameters that describe a mouse wheel event.
diff --git a/src/input/qkeyboardcontroller.cpp b/src/input/qkeyboardcontroller.cpp
index fc069edc3..17345c6c2 100644
--- a/src/input/qkeyboardcontroller.cpp
+++ b/src/input/qkeyboardcontroller.cpp
@@ -47,7 +47,7 @@ using namespace Qt3DCore;
namespace Qt3DInput {
/*!
- \class Qt3DCore::QKeyboardControllerPrivate
+ \class Qt3DInput::QKeyboardControllerPrivate
\internal
*/
QKeyboardControllerPrivate::QKeyboardControllerPrivate()
@@ -56,7 +56,7 @@ QKeyboardControllerPrivate::QKeyboardControllerPrivate()
}
/*!
- \class Qt3DCore::QKeyboardController
+ \class Qt3DInput::QKeyboardController
\inmodule Qt3DInput
\since 5.5
*/
@@ -65,7 +65,7 @@ QKeyboardControllerPrivate::QKeyboardControllerPrivate()
\qmltype KeyboardController
\inqmlmodule Qt3D.Input
\since 5.5
- \instantiates Qt3DCore::QKeyboardController
+ \instantiates Qt3DInput::QKeyboardController
\inherits Node
*/
diff --git a/src/input/qkeyboardinput.cpp b/src/input/qkeyboardinput.cpp
index 332799457..bf9cac074 100644
--- a/src/input/qkeyboardinput.cpp
+++ b/src/input/qkeyboardinput.cpp
@@ -46,7 +46,7 @@ using namespace Qt3DCore;
namespace Qt3DInput {
/*!
- \class Qt3DCore::QKeyboardInputPrivate
+ \class Qt3DInput::QKeyboardInputPrivate
\internal
*/
QKeyboardInputPrivate::QKeyboardInputPrivate()
@@ -58,7 +58,7 @@ QKeyboardInputPrivate::QKeyboardInputPrivate()
}
/*!
- \class Qt3DCore::QKeyboardInput
+ \class Qt3DInput::QKeyboardInput
\inmodule Qt3DInput
\since 5.5
*/
@@ -66,7 +66,7 @@ QKeyboardInputPrivate::QKeyboardInputPrivate()
/*!
\qmltype KeyboardInput
\inqmlmodule Qt3D.Input
- \instantiates Qt3DCore::QKeyboardInput
+ \instantiates Qt3DInput::QKeyboardInput
\inherits Component3D
\since 5.5
*/
diff --git a/src/input/qmousecontroller.cpp b/src/input/qmousecontroller.cpp
index a31f598be..49acc17aa 100644
--- a/src/input/qmousecontroller.cpp
+++ b/src/input/qmousecontroller.cpp
@@ -50,7 +50,7 @@ QMouseControllerPrivate::QMouseControllerPrivate()
}
/*!
- * \class Qt3DCore::QMouseController
+ * \class Qt3DInput::QMouseController
* \inmodule Qt3DInput
*
* \brief Qt3DCore::QMouseController is in charge of dispatching mouse events to
diff --git a/src/input/qmouseinput.cpp b/src/input/qmouseinput.cpp
index a56e229f4..dc0bfe567 100644
--- a/src/input/qmouseinput.cpp
+++ b/src/input/qmouseinput.cpp
@@ -55,7 +55,7 @@ QMouseInputPrivate::QMouseInputPrivate()
}
/*!
- * \class Qt3DCore::QMouseInput
+ * \class Qt3DInput::QMouseInput
* \inmodule Qt3DInput
*
* \brief Provides a mean of being notified about mouse events when attached to
diff --git a/src/logic/doc/src/qt3dlogic-module.qdoc b/src/logic/doc/src/qt3dlogic-module.qdoc
index 265f84ab1..f43eb44e2 100644
--- a/src/logic/doc/src/qt3dlogic-module.qdoc
+++ b/src/logic/doc/src/qt3dlogic-module.qdoc
@@ -27,7 +27,7 @@
/*!
\module Qt3DLogic
- \title Qt3D Collision C++ Classes
+ \title Qt3D Logic C++ Classes
\brief The Qt3D Logic module enables synchronizing frames with the Qt 3D
backend.
\ingroup modules
@@ -49,6 +49,14 @@
*/
/*!
+ \namespace Qt3DLogic
+ \inmodule Qt3DLogic
+ \ingroup qt3d-namespaces
+
+ \brief Contains classes that enable frame synchronization.
+*/
+
+/*!
\qmlmodule Qt3D.Logic 2.0
\title Qt3D Logic QML Types
\ingroup qmlmodules
diff --git a/src/logic/qlogicaspect.cpp b/src/logic/qlogicaspect.cpp
index 395c536b5..a1d40fd79 100644
--- a/src/logic/qlogicaspect.cpp
+++ b/src/logic/qlogicaspect.cpp
@@ -61,7 +61,7 @@ using namespace Qt3DCore;
namespace Qt3DLogic {
/*!
- \class Qt3DCore::QLogicAspectPrivate
+ \class Qt3DLogic::QLogicAspectPrivate
\internal
*/
QLogicAspectPrivate::QLogicAspectPrivate()
diff --git a/src/logic/qlogiccomponent.cpp b/src/logic/qlogiccomponent.cpp
index 3b2755538..2b99f0e14 100644
--- a/src/logic/qlogiccomponent.cpp
+++ b/src/logic/qlogiccomponent.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DLogic {
/*!
- \class Qt3DCore::QLogicComponentPrivate
+ \class Qt3DLogic::QLogicComponentPrivate
\internal
*/
QLogicComponentPrivate::QLogicComponentPrivate()
@@ -51,7 +51,7 @@ QLogicComponentPrivate::QLogicComponentPrivate()
}
/*!
- \class Qt3DCore::QLogicComponent
+ \class Qt3DLogic::QLogicComponent
\inmodule Qt3DLogic
\since 5.5
\brief Provides a way to have a synchronous function executed each frame.
@@ -71,7 +71,7 @@ QLogicComponentPrivate::QLogicComponentPrivate()
/*!
\qmltype LogicComponent
\inqmlmodule Qt3D.Logic
- \instantiates Qt3DCore::QLogicComponent
+ \instantiates Qt3DLogic::QLogicComponent
\inherits Component3D
\since 5.5
*/
diff --git a/src/render/defaults/qgoochmaterial.cpp b/src/render/defaults/qgoochmaterial.cpp
index c59c197a2..3ab810056 100644
--- a/src/render/defaults/qgoochmaterial.cpp
+++ b/src/render/defaults/qgoochmaterial.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DCore::QGoochMaterialPrivate
+ \class Qt3DRender::QGoochMaterialPrivate
\internal
*/
QGoochMaterialPrivate::QGoochMaterialPrivate()
@@ -129,7 +129,7 @@ void QGoochMaterialPrivate::init()
}
/*!
- \class Qt3DCore::QGoochMaterial
+ \class Qt3DRender::QGoochMaterial
\brief The QGoochMaterial provides a material that implements the Gooch
shading model, popular in CAD and CAM applications.
\inmodule Qt3DRenderer
diff --git a/src/render/defaults/qskyboxentity.cpp b/src/render/defaults/qskyboxentity.cpp
index 8fd526c46..387646b61 100644
--- a/src/render/defaults/qskyboxentity.cpp
+++ b/src/render/defaults/qskyboxentity.cpp
@@ -58,7 +58,7 @@ using namespace Qt3DCore;
namespace Qt3DRender {
/*!
- * \class Qt3DCore::QSkyboxEntityPrivate
+ * \class Qt3DRender::QSkyboxEntityPrivate
* \internal
*/
QSkyboxEntityPrivate::QSkyboxEntityPrivate()
@@ -184,7 +184,7 @@ void QSkyboxEntityPrivate::reloadTexture()
}
/*!
- * \class Qt3DCore::QSkyboxEntity
+ * \class Qt3DRender::QSkyboxEntity
* \inmodule Qt3DRenderer
*
* \brief Qt3DCore::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can
diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc
index 6e0e8806d..aa4dac44f 100644
--- a/src/render/doc/src/qt3drender-module.qdoc
+++ b/src/render/doc/src/qt3drender-module.qdoc
@@ -73,6 +73,14 @@
*/
/*!
+ \namespace Qt3DRender
+ \inmodule Qt3DRender
+ \ingroup qt3d-namespaces
+
+ \brief Contains classes that enable 2D and 3D rendering.
+*/
+
+/*!
\qmlmodule Qt3D.Render 2.0
\title Qt3D Render QML Types
\ingroup qmlmodules
diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp
index d2bc671ca..d223c2ac0 100644
--- a/src/render/framegraph/qcameraselector.cpp
+++ b/src/render/framegraph/qcameraselector.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DCore::CameraSelector
+ \class Qt3DRender::CameraSelector
*/
/*! \internal */
diff --git a/src/render/framegraph/qframegraph.cpp b/src/render/framegraph/qframegraph.cpp
index 8c8c34f59..080d83e48 100644
--- a/src/render/framegraph/qframegraph.cpp
+++ b/src/render/framegraph/qframegraph.cpp
@@ -74,7 +74,7 @@ QFrameGraphPrivate::QFrameGraphPrivate()
\qmltype FrameGraph
\instantiates Qt3DRender::QFrameGraph
\inherits Component3D
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For OpenGL ...
*/
diff --git a/src/render/framegraph/qframegraphnode.cpp b/src/render/framegraph/qframegraphnode.cpp
index 519843fa7..acddc838e 100644
--- a/src/render/framegraph/qframegraphnode.cpp
+++ b/src/render/framegraph/qframegraphnode.cpp
@@ -65,7 +65,7 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate()
/*!
\qmltype FrameGraphNode
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\instantiates QFrameGraphNode
\inherits Node
\since 5.5
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index 1dad3c1db..9c9ab58cd 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -62,7 +62,7 @@ QLayerFilterPrivate::QLayerFilterPrivate()
\qmltype LayerFilter
\instantiates Qt3DRender::QLayerFilter
\inherits FrameGraphNode
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For ...
*/
diff --git a/src/render/framegraph/qnodraw.cpp b/src/render/framegraph/qnodraw.cpp
index e24b2ca83..2e9137ffe 100644
--- a/src/render/framegraph/qnodraw.cpp
+++ b/src/render/framegraph/qnodraw.cpp
@@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- * \class Qt3DCore::QNoDraw::QNoDraw
+ * \class Qt3DRender::QNoDraw::QNoDraw
*
* \brief When a Qt3DCore::QNoDraw node is present in a FrameGraph branch, this
* prevents the renderer from rendering any primitive.
diff --git a/src/render/framegraph/qsortcriterion.cpp b/src/render/framegraph/qsortcriterion.cpp
index 11577631f..c907e2a18 100644
--- a/src/render/framegraph/qsortcriterion.cpp
+++ b/src/render/framegraph/qsortcriterion.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DCore::QSortCriterionPrivate
+ \class Qt3DRender::QSortCriterionPrivate
\internal
*/
QSortCriterionPrivate::QSortCriterionPrivate()
diff --git a/src/render/framegraph/qsortmethod.cpp b/src/render/framegraph/qsortmethod.cpp
index d2a4aa6ab..a624d31d8 100644
--- a/src/render/framegraph/qsortmethod.cpp
+++ b/src/render/framegraph/qsortmethod.cpp
@@ -47,7 +47,7 @@ using namespace Qt3DCore;
namespace Qt3DRender {
/*!
- \class Qt3DCore::QSortMethodPrivate
+ \class Qt3DRender::QSortMethodPrivate
\internal
*/
QSortMethodPrivate::QSortMethodPrivate()
diff --git a/src/render/framegraph/qstateset.cpp b/src/render/framegraph/qstateset.cpp
index 8ba2d9bc5..3e9bdbe0f 100644
--- a/src/render/framegraph/qstateset.cpp
+++ b/src/render/framegraph/qstateset.cpp
@@ -52,7 +52,7 @@ QStateSetPrivate::QStateSetPrivate()
}
/*!
- * \class Qt3DCore::QStateSet
+ * \class Qt3DRender::QStateSet
* \inmodule Qt3DRender
*
* \brief The Qt3DCore::QStateSet FrameGraph node offers a way of specifying a set
diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp
index ce3486555..64e8faa22 100644
--- a/src/render/frontend/qlayer.cpp
+++ b/src/render/frontend/qlayer.cpp
@@ -61,7 +61,7 @@ QLayerPrivate::QLayerPrivate()
\qmltype Layer
\instantiates Qt3DRender::QLayer
\inherits Component3D
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For ...
*/
diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp
index c69667138..e219af188 100644
--- a/src/render/frontend/qrenderaspect.cpp
+++ b/src/render/frontend/qrenderaspect.cpp
@@ -126,7 +126,7 @@ using namespace Qt3DCore;
namespace Qt3DRender {
/*!
- \class Qt3DCore::QRenderAspectPrivate
+ \class Qt3DRender::QRenderAspectPrivate
\internal
*/
QRenderAspectPrivate::QRenderAspectPrivate(QRenderAspect::RenderType type)
diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp
index a4272bcba..793ca27b4 100644
--- a/src/render/lights/qabstractlight.cpp
+++ b/src/render/lights/qabstractlight.cpp
@@ -51,7 +51,7 @@ namespace Qt3DRender
/*!
- \class Qt3DCore::QAbstractLightPrivate
+ \class Qt3DRender::QAbstractLightPrivate
\internal
*/
QAbstractLightPrivate::QAbstractLightPrivate()
@@ -71,7 +71,7 @@ void QAbstractLight::copy(const QNode *ref)
}
/*!
- \class Qt3DCore::QAbstractLight
+ \class Qt3DRender::QAbstractLight
\inmodule Qt3DRender
*/
diff --git a/src/render/lights/qdirectionallight.cpp b/src/render/lights/qdirectionallight.cpp
index e6bbb7541..c523215a9 100644
--- a/src/render/lights/qdirectionallight.cpp
+++ b/src/render/lights/qdirectionallight.cpp
@@ -62,7 +62,7 @@ namespace Qt3DRender {
*/
/*!
- \class Qt3DCore::QDirectionalLightPrivate
+ \class Qt3DRender::QDirectionalLightPrivate
\internal
*/
QDirectionalLightPrivate::QDirectionalLightPrivate()
diff --git a/src/render/lights/qpointlight.cpp b/src/render/lights/qpointlight.cpp
index 94653ee41..2fb6755cf 100644
--- a/src/render/lights/qpointlight.cpp
+++ b/src/render/lights/qpointlight.cpp
@@ -78,7 +78,7 @@ QPointLightPrivate::QPointLightPrivate()
\qmltype PointLight
\instantiates Qt3DRender::QPointLight
\inherits AbstractLight
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For OpenGL ...
*/
diff --git a/src/render/lights/qspotlight.cpp b/src/render/lights/qspotlight.cpp
index 1e9244c91..b8f360bf4 100644
--- a/src/render/lights/qspotlight.cpp
+++ b/src/render/lights/qspotlight.cpp
@@ -63,7 +63,7 @@ namespace Qt3DRender {
*/
/*!
- \class Qt3DCore::QSpotLightPrivate
+ \class Qt3DRender::QSpotLightPrivate
\internal
*/
QSpotLightPrivate::QSpotLightPrivate()
@@ -81,9 +81,9 @@ QSpotLightPrivate::QSpotLightPrivate()
/*!
\qmltype SpotLight
- \instantiates Qt3DCore::QSpotLight
+ \instantiates Qt3DRender::QSpotLight
\inherits AbstractLight
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For OpenGL ...
*/
diff --git a/src/render/materialsystem/qannotation.cpp b/src/render/materialsystem/qannotation.cpp
index 85a46fcbe..642e0c8c2 100644
--- a/src/render/materialsystem/qannotation.cpp
+++ b/src/render/materialsystem/qannotation.cpp
@@ -64,7 +64,7 @@ QAnnotationPrivate::QAnnotationPrivate()
\qmltype Annotation
\instantiates Qt3DRender::QAnnotation
\inherits Node
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For annotating ...
*/
diff --git a/src/render/materialsystem/qopenglfilter.cpp b/src/render/materialsystem/qopenglfilter.cpp
index fa9437e4a..e334ca88e 100644
--- a/src/render/materialsystem/qopenglfilter.cpp
+++ b/src/render/materialsystem/qopenglfilter.cpp
@@ -74,7 +74,7 @@ public:
\qmltype OpenGLFilter
\instantiates Qt3DRender::QOpenGLFilter
\inherits QtObject
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For OpenGL ...
*/
diff --git a/src/render/materialsystem/qparametermapping.cpp b/src/render/materialsystem/qparametermapping.cpp
index 3890bf8b2..1583983e2 100644
--- a/src/render/materialsystem/qparametermapping.cpp
+++ b/src/render/materialsystem/qparametermapping.cpp
@@ -61,7 +61,7 @@ QParameterMappingPrivate::QParameterMappingPrivate()
\qmltype ParameterMapping
\instantiates Qt3DRender::QParameterMapping
\inherits Node
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief For ...
*/
diff --git a/src/render/renderstates/qblendstate.cpp b/src/render/renderstates/qblendstate.cpp
index 76e945372..c507e9a5e 100644
--- a/src/render/renderstates/qblendstate.cpp
+++ b/src/render/renderstates/qblendstate.cpp
@@ -65,7 +65,7 @@ public:
};
/*!
- \class Qt3DCore::QBlendState
+ \class Qt3DRender::QBlendState
\inmodule Qt3DRenderer
\since 5.5
\brief Encapsulates blending information.
@@ -73,9 +73,9 @@ public:
/*!
\qmltype BlendState
- \instantiates Qt3DCore::QBlendState
+ \instantiates Qt3DRender::QBlendState
\inherits RenderState
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief Encapsulates blending information
*/
@@ -244,9 +244,9 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha)
/*!
\qmltype BlendStateSeparate
- \instantiates Qt3DCore::QBlendStateSeparate
+ \instantiates Qt3DRender::QBlendStateSeparate
\inherits RenderState
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief Encapsulates blending information
*/
diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp
index 9063ef9ad..3850a9dc7 100644
--- a/src/render/renderstates/qclipplane.cpp
+++ b/src/render/renderstates/qclipplane.cpp
@@ -53,7 +53,7 @@ public:
};
/*!
- \class Qt3DCore::QClipPlane
+ \class Qt3DRender::QClipPlane
\inmodule Qt3DRenderer
\since 5.5
\brief Enables an additional OpenGL clipping plane that can be in shaders
@@ -67,9 +67,9 @@ public:
/*!
\qmltype ClipPlane
- \instantiates Qt3DCore::QClipPlane
+ \instantiates Qt3DRender::QClipPlane
\inherits RenderState
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief Enables an additional OpenGL clipping plane that can be in shaders
using gl_ClipDistance
diff --git a/src/render/renderstates/qcolormask.cpp b/src/render/renderstates/qcolormask.cpp
index 6f4761894..d517d30bc 100644
--- a/src/render/renderstates/qcolormask.cpp
+++ b/src/render/renderstates/qcolormask.cpp
@@ -61,7 +61,7 @@ public:
};
/*!
- \class Qt3DCore::QColorMask
+ \class Qt3DRender::QColorMask
\inmodule Qt3DRenderer
\brief Allows specifying which color components should be written to the
diff --git a/src/render/renderstates/qrenderstate.cpp b/src/render/renderstates/qrenderstate.cpp
index 821ec7e9e..5b418f334 100644
--- a/src/render/renderstates/qrenderstate.cpp
+++ b/src/render/renderstates/qrenderstate.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DCore::QRenderStatePrivate
+ \class Qt3DRender::QRenderStatePrivate
\internal
*/
QRenderStatePrivate::QRenderStatePrivate(QRenderState::Type type)
diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp
index e19c2fe8d..ce4efeaf8 100644
--- a/src/render/texture/qabstracttextureimage.cpp
+++ b/src/render/texture/qabstracttextureimage.cpp
@@ -45,15 +45,15 @@ using namespace Qt3DCore;
namespace Qt3DRender {
/*!
- \class Qt3DCore::QAbstractTextureImagePrivate
+ \class Qt3DRender::QAbstractTextureImagePrivate
\internal
*/
/*!
\qmltype AbstractTextureImage
- \instantiates Qt3DCore::QAbstractTextureImage
+ \instantiates Qt3DRender::QAbstractTextureImage
\inherits Node
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\qmlabstract
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture image.
diff --git a/src/render/texture/qtextureimage.cpp b/src/render/texture/qtextureimage.cpp
index fd2f6524c..19f729eeb 100644
--- a/src/render/texture/qtextureimage.cpp
+++ b/src/render/texture/qtextureimage.cpp
@@ -111,7 +111,7 @@ private:
\qmltype TextureImage
\instantiates Qt3DRender::QTextureImage
\inherits AbstractTextureImage
- \inqmlmodule Qt3D.Renderer
+ \inqmlmodule Qt3D.Render
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture
image from an image source.