diff options
| author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2015-10-30 14:18:19 +0100 |
|---|---|---|
| committer | Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com> | 2015-11-06 08:05:36 +0000 |
| commit | 872efa5619d20a421142a88e1a38f131c08d44d1 (patch) | |
| tree | 2f7332e6beb78cadd61e3333147d13e8ebabfbda | |
| parent | 537dc6222a5da789153e7c32953d3d7a5ca11980 (diff) | |
Doc: Documentation clean up
- Changed 'Qt3D' references to 'Qt 3D'.
- Fixed incorrect \inqmlmodule instances.
- Fixed broken \printuntil instances in the example docs.
- Updated the namespace qualifier for a few class references.
Change-Id: I250afe6843b10ed520f9ce5d7465203cc5c212c1
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
51 files changed, 324 insertions, 322 deletions
diff --git a/examples/qt3d/assimp/doc/src/assimp.qdoc b/examples/qt3d/assimp/doc/src/assimp.qdoc index c0955c4f5..c3ab093a1 100644 --- a/examples/qt3d/assimp/doc/src/assimp.qdoc +++ b/examples/qt3d/assimp/doc/src/assimp.qdoc @@ -27,6 +27,6 @@ /*! \example assimp - \title Qt3D: assimp Example + \title Qt 3D: assimp Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc index 75da8e12d..86ed7e3e8 100644 --- a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc +++ b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc @@ -27,7 +27,7 @@ /*! \example basicshapes-cpp - \title Qt3D: Basic Shapes C++ Example + \title Qt 3D: Basic Shapes C++ Example \ingroup qt3d-examples-cpp \brief Shows four basic shapes that Qt3D offers and sets up a mesh for each of them. diff --git a/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc b/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc index 1a2ea6d2d..d7061bd74 100644 --- a/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc +++ b/examples/qt3d/bigmodel-qml/doc/src/bigmodel-qml.qdoc @@ -27,6 +27,6 @@ /*! \example bigmodel-qml - \title Qt3D: Big Model QML Example + \title Qt 3D: Big Model QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc b/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc index 75f2dab20..39a3d370d 100644 --- a/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc +++ b/examples/qt3d/bigscene-cpp/doc/src/bigscene-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example bigscene-cpp - \title Qt3D: Big Scene C++ Example + \title Qt 3D: Big Scene C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc b/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc index c27590221..84e3cb4d7 100644 --- a/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc +++ b/examples/qt3d/cpp_example/doc/src/cpp_example.qdoc @@ -27,6 +27,6 @@ /*! \example cpp_example - \title Qt3D: C++ Example + \title Qt 3D: C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc b/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc index f33cfb7e1..45b74a4ba 100644 --- a/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc +++ b/examples/qt3d/cylinder-cpp/doc/src/cylinder-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example cylinder-cpp - \title Qt3D: Cylinder C++ Example + \title Qt 3D: Cylinder C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc b/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc index 841604eb9..7ab372c72 100644 --- a/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc +++ b/examples/qt3d/cylinder-qml/doc/src/cylinder-qml.qdoc @@ -27,6 +27,6 @@ /*! \example cylinder-qml - \title Qt3D: Cylinder QML Example + \title Qt 3D: Cylinder QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc b/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc index 7c7beb369..d5327345a 100644 --- a/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc +++ b/examples/qt3d/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example deferred-renderer-cpp - \title Qt3D: Deferred Renderer C++ Example + \title Qt 3D: Deferred Renderer C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc b/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc index dba530e5b..24003ccb1 100644 --- a/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc +++ b/examples/qt3d/deferred-renderer-qml/doc/src/deferred-renderer-qml.qdoc @@ -27,6 +27,6 @@ /*! \example deferred-renderer-qml - \title Qt3D: Deferred Renderer QML Example + \title Qt 3D: Deferred Renderer QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc b/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc index c5ab20cf4..e9057c2d1 100644 --- a/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc +++ b/examples/qt3d/dynamicscene-cpp/doc/src/dynamicscene-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example dynamicscene-cpp - \title Qt3D: Dynamic Scene C++ Example + \title Qt 3D: Dynamic Scene C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc b/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc index 9f6c49341..02141aef0 100644 --- a/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc +++ b/examples/qt3d/enabled-qml/doc/src/enabled-qml.qdoc @@ -27,6 +27,6 @@ /*! \example enabled-qml - \title Qt3D: Enabled QML Example + \title Qt 3D: Enabled QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/gltf/doc/src/gltf.qdoc b/examples/qt3d/gltf/doc/src/gltf.qdoc index 22757633d..f03d453f5 100644 --- a/examples/qt3d/gltf/doc/src/gltf.qdoc +++ b/examples/qt3d/gltf/doc/src/gltf.qdoc @@ -27,6 +27,6 @@ /*! \example gltf - \title Qt3D: glTF Assets Example + \title Qt 3D: glTF Assets Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc b/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc index 8fd5e75f4..130e06698 100644 --- a/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc +++ b/examples/qt3d/keyboardinput-qml/doc/src/keyboardinput-qml.qdoc @@ -27,6 +27,6 @@ /*! \example keyboardinput-qml - \title Qt3D: Keyboard Input QML Example + \title Qt 3D: Keyboard Input QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc b/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc index c22c6159b..8dc320fac 100644 --- a/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc +++ b/examples/qt3d/loader-qml/doc/src/loader-qml.qdoc @@ -27,6 +27,6 @@ /*! \example loader-qml - \title Qt3D: Loader QML Example + \title Qt 3D: Loader QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc b/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc index 65f92c0a0..e94b7f4ff 100644 --- a/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc +++ b/examples/qt3d/materials-cpp/doc/src/materials-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example materials-cpp - \title Qt3D: Materials C++ Example + \title Qt 3D: Materials C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/materials/doc/src/materials.qdoc b/examples/qt3d/materials/doc/src/materials.qdoc index 22093941b..e4e2b01c1 100644 --- a/examples/qt3d/materials/doc/src/materials.qdoc +++ b/examples/qt3d/materials/doc/src/materials.qdoc @@ -27,6 +27,6 @@ /*! \example materials - \title Qt3D: Materials QML Example + \title Qt 3D: Materials QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc b/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc index 27cc1a4a3..2316c1c70 100644 --- a/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc +++ b/examples/qt3d/multiviewport/doc/src/multiviewport.qdoc @@ -27,6 +27,6 @@ /*! \example multiviewport - \title Qt3D: Multi Viewport QML Example + \title Qt 3D: Multi Viewport QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc index f50a84fec..9b65226e9 100644 --- a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc +++ b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc @@ -36,7 +36,7 @@ /*! \example planets-qml - \title Qt3D: Planets QML Example + \title Qt 3D: Planets QML Example \ingroup qt3d-examples-qml \brief Demonstrates combining Qt 3D rendering and Qt Quick 2 elements. diff --git a/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc b/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc index dce4eea27..e10a8ea2a 100644 --- a/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc +++ b/examples/qt3d/playground-qml/doc/src/playground-qml.qdoc @@ -27,6 +27,6 @@ /*! \example playground-qml - \title Qt3D: Playground QML Example + \title Qt 3D: Playground QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/scene3d/doc/src/scene3d.qdoc b/examples/qt3d/scene3d/doc/src/scene3d.qdoc index 8ef077dd8..3b905f10a 100644 --- a/examples/qt3d/scene3d/doc/src/scene3d.qdoc +++ b/examples/qt3d/scene3d/doc/src/scene3d.qdoc @@ -27,6 +27,6 @@ /*! \example scene3d - \title Qt3D: Scene3D QML Example + \title Qt 3D: Scene3D QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc index fd3377a8b..7fd8d11d7 100644 --- a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc +++ b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc @@ -27,15 +27,15 @@ /*! \example shadow-map-qml - \title Qt3D: Shadow Map QML Example + \title Qt 3D: Shadow Map QML Example \ingroup qt3d-examples-qml - \brief A Qt3D QML application that illustrates how to render a scene in Qt3D + \brief A Qt 3D QML application that illustrates how to render a scene in Qt 3D with shadows. \image shadowmapping-qt3d.png - \e {Qt3D Shadow Map} illustrates how to configure the renderer in order to + \e {Qt 3D Shadow Map} illustrates how to configure the renderer in order to accommodate custom rendering techniques. The example application displays a self-shadowed plane and trefoil knot. @@ -59,7 +59,7 @@ \quotefromfile shadow-map-qml/main.qml \skipto import Qt3D - \printuntil Renderer + \printuntil Render The first entities we create are a \l Camera, which represents the camera used for the final rendering, and a \l Configuration, which allows us to diff --git a/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc b/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc index ee0b55fff..4c76445e5 100644 --- a/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc +++ b/examples/qt3d/simple-cpp/doc/src/simple-cpp.qdoc @@ -27,6 +27,6 @@ /*! \example simple-cpp - \title Qt3D: Simple C++ Example + \title Qt 3D: Simple C++ Example \ingroup qt3d-examples-cpp */ diff --git a/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc b/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc index 8e2be44bd..1173cbefe 100644 --- a/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc +++ b/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc @@ -27,6 +27,6 @@ /*! \example simple-qml - \title Qt3D: Simple QML Example + \title Qt 3D: Simple QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/skybox/doc/src/skybox.qdoc b/examples/qt3d/skybox/doc/src/skybox.qdoc index b84893416..e8ebf9b7f 100644 --- a/examples/qt3d/skybox/doc/src/skybox.qdoc +++ b/examples/qt3d/skybox/doc/src/skybox.qdoc @@ -27,6 +27,6 @@ /*! \example skybox - \title Qt3D: Skybox QML Example + \title Qt 3D: Skybox QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc b/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc index 10ab1b722..eb731d4b1 100644 --- a/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc +++ b/examples/qt3d/tessellation-modes/doc/src/tessellation-modes.qdoc @@ -27,6 +27,6 @@ /*! \example tessellation-modes - \title Qt3D: Tessellation Modes QML Example + \title Qt 3D: Tessellation Modes QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc b/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc index 37cf26594..0004f7878 100644 --- a/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc +++ b/examples/qt3d/torus-qml/doc/src/torus-qml.qdoc @@ -27,6 +27,6 @@ /*! \example torus-qml - \title Qt3D: Torus QML Example + \title Qt 3D: Torus QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/wave/doc/src/wave.qdoc b/examples/qt3d/wave/doc/src/wave.qdoc index e967b14df..e0502f6b7 100644 --- a/examples/qt3d/wave/doc/src/wave.qdoc +++ b/examples/qt3d/wave/doc/src/wave.qdoc @@ -27,6 +27,6 @@ /*! \example wave - \title Qt3D: Wave QML Example + \title Qt 3D: Wave QML Example \ingroup qt3d-examples-qml */ diff --git a/examples/qt3d/wireframe/doc/src/wireframe.qdoc b/examples/qt3d/wireframe/doc/src/wireframe.qdoc index 2b0cdda62..dcb86c398 100644 --- a/examples/qt3d/wireframe/doc/src/wireframe.qdoc +++ b/examples/qt3d/wireframe/doc/src/wireframe.qdoc @@ -27,7 +27,7 @@ /*! \example wireframe - \title Qt3D: Wireframe QML Example + \title Qt 3D: Wireframe QML Example \ingroup qt3d-examples-qml \brief A Qt3D QML application that implements a single-pass wireframe @@ -56,7 +56,7 @@ \quotefromfile wireframe/TrefoilKnot.qml \skipto import Qt3D - \printuntil Renderer + \printuntil Render To use components from other aspects, we would need to import the corresponding QML module, too. diff --git a/src/collision/qgeometrycollider.cpp b/src/collision/qgeometrycollider.cpp index 6f7458dca..48ce072f7 100644 --- a/src/collision/qgeometrycollider.cpp +++ b/src/collision/qgeometrycollider.cpp @@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DCollision { /*! - \class Qt3DRender::QGeometryColliderPrivate + \class Qt3DCollision::QGeometryColliderPrivate \internal */ QGeometryColliderPrivate::QGeometryColliderPrivate() @@ -51,7 +51,7 @@ QGeometryColliderPrivate::QGeometryColliderPrivate() } /*! - \class Qt3DRender::QGeometryCollider + \class Qt3DCollision::QGeometryCollider \inmodule Qt3DCollision \since 5.5 \brief Represents a geometric mesh used for collision detection @@ -60,7 +60,7 @@ QGeometryColliderPrivate::QGeometryColliderPrivate() /*! \qmltype GeometryCollider \inqmlmodule Qt3D.Collision - \instantiates Qt3DRender::QGeometryCollider + \instantiates Qt3DCollision::QGeometryCollider \inherits Component3D \since 5.5 */ diff --git a/src/core/core-components/qcamera.cpp b/src/core/core-components/qcamera.cpp index 53d22f1e5..e1eb812e7 100644 --- a/src/core/core-components/qcamera.cpp +++ b/src/core/core-components/qcamera.cpp @@ -57,7 +57,7 @@ QCameraPrivate::QCameraPrivate() \qmltype Camera \instantiates Qt3DCore::QCamera \inherits Entity - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 */ diff --git a/src/core/core-components/qcameralens.cpp b/src/core/core-components/qcameralens.cpp index 206745c28..841823a69 100644 --- a/src/core/core-components/qcameralens.cpp +++ b/src/core/core-components/qcameralens.cpp @@ -422,7 +422,7 @@ QMatrix4x4 QCameraLens::projectionMatrix() const /*! \qmltype CameraLens \instantiates Qt3DCore::QCameraLens - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \inherits Component3D \since 5.5 */ diff --git a/src/core/jobs/qthreadpooler.cpp b/src/core/jobs/qthreadpooler.cpp index 7a315884b..590b89b17 100644 --- a/src/core/jobs/qthreadpooler.cpp +++ b/src/core/jobs/qthreadpooler.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DCore { /*! - \class Qt3DCore::QThreadPoolerPrivate + \class Qt3DCore::QThreadPooler \internal */ QThreadPooler::QThreadPooler(QObject *parent) diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp index 338a6a2fa..baa201b0f 100644 --- a/src/core/nodes/qcomponent.cpp +++ b/src/core/nodes/qcomponent.cpp @@ -181,7 +181,7 @@ QComponent::QComponent(QComponentPrivate &dd, QNode *parent) /*! \qmltype Component3D \instantiates Qt3DCore::QComponent - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \inherits Node \since 5.5 */ diff --git a/src/core/transforms/qmatrixtransform.cpp b/src/core/transforms/qmatrixtransform.cpp index 74122122d..15e024fec 100644 --- a/src/core/transforms/qmatrixtransform.cpp +++ b/src/core/transforms/qmatrixtransform.cpp @@ -93,7 +93,7 @@ QMatrix4x4 QMatrixTransform::transformMatrix() const /*! \qmltype MatrixTransform - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 \instantiates Qt3DCore::QMatrixTransform */ diff --git a/src/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc index 080eeab98..d34e72e53 100644 --- a/src/doc/src/qcircularbuffer.qdoc +++ b/src/doc/src/qcircularbuffer.qdoc @@ -35,7 +35,7 @@ ****************************************************************************/ /*! - \class Qt3D::QCircularBuffer + \class Qt3DCore::QCircularBuffer \inmodule Qt3DCore \brief A template class providing a dynamic circular array. @@ -110,7 +110,7 @@ Another way to access the data stored in a QCircularBuffer is to call data(), or dataOne() and dataTwo() depending on if the buffer is linearized or not. See the discussion in isLinearised() for more information. The data() function - returns a Qt3D::QCircularBuffer::array_range object describing the array of items stored + returns a Qt3DCore::QCircularBuffer::array_range object describing the array of items stored in the QCircularBuffer. You can use the pointer in the array_range to directly access and modify the elements stored in the circular buffer. The pointer is also useful if you need to pass a QCircularBuffer to a function that accepts a plain @@ -184,26 +184,26 @@ support \c operator==(). These requirements are documented on a per-function basis. - QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3D::QCircularBuffer::}{const_iterator}) - and \l {Qt3D::QCircularBuffer::}{iterator}). In practice, these are rarely used, + QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3DCore::QCircularBuffer::}{const_iterator}) + and \l {Qt3DCore::QCircularBuffer::}{iterator}). In practice, these are rarely used, because you can use indexes into the QCircularBuffer. QCircularBuffer does \e not support inserting, prepending, appending, or replacing with references to its own values. Doing so will cause your application to abort with an error message. - \sa Qt3D::QCircularBuffer::iterator, Qt3D::QCircularBuffer::const_iterator, + \sa Qt3DCore::QCircularBuffer::iterator, Qt3DCore::QCircularBuffer::const_iterator, QVector, QList, QLinkedList */ -/*! \fn Qt3D::QCircularBuffer::QCircularBuffer() +/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer() Constructs an empty circular buffer with zero capacity. \sa resize(), setCapacity() */ -/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(int capacity) +/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity) Constructs an empty circular buffer with an initial capacity of \a capacity elements. @@ -211,7 +211,7 @@ \sa resize(), setCapacity() */ -/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(int capacity, const T &value) +/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, const T &value) Constructs a circular buffer with an initial capacity and size of \a capacity elements. @@ -221,7 +221,7 @@ \sa resize(), setCapacity(), fill() */ -/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(int capacity, int size, const T &value) +/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, int size, const T &value) Constructs a circular buffer with an initial capacity of \a capacity elements and initial size of \a size elements. @@ -231,7 +231,7 @@ \sa resize(), setCapacity(), fill() */ -/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other) +/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other) Constructs a copy of \a other. @@ -243,18 +243,18 @@ \sa operator=() */ -/*! \fn Qt3D::QCircularBuffer::~QCircularBuffer() +/*! \fn Qt3DCore::QCircularBuffer::~QCircularBuffer() Destroys the circular buffer. */ -/*! \fn QCircularBuffer &Qt3D::QCircularBuffer::operator=(const QCircularBuffer<T> &other) +/*! \fn QCircularBuffer &Qt3DCore::QCircularBuffer::operator=(const QCircularBuffer<T> &other) Assigns \a other to this circular buffer and returns a reference to this circular buffer. */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::begin() +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::begin() Returns an \l{STL-Style iterators}{STL-style iterator} pointing to the first item in the circular buffer. @@ -262,12 +262,12 @@ \sa constBegin(), end() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::begin() const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::begin() const \overload */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::constBegin() const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constBegin() const Returns a const \l{STL-Style Iterators}{STL-style iterator} pointing to the first item in the circular buffer. @@ -275,7 +275,7 @@ \sa begin(), constEnd() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::end() +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::end() Returns an \l {STL-Style Iterators} {STL-style iterator} pointing to the imaginary item after the last item in the circular buffer. @@ -283,12 +283,12 @@ \sa begin(), constEnd() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::end() const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::end() const \overload */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::constEnd() const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constEnd() const Returns a const \l{STL-Style Iterators} {STL-style iterator} pointing to the imaginary item after the last item in the circular buffer. @@ -296,7 +296,7 @@ \sa constBegin(), end() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::erase(const_iterator pos) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator pos) Removes the item pointed to by the iterator \a pos from the circular buffer, and returns an iterator to the next item in the circular @@ -305,7 +305,7 @@ \sa insert(), remove() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::erase(const_iterator begin, const_iterator end) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator begin, const_iterator end) \overload @@ -314,65 +314,65 @@ before the call. */ -/*! \fn void Qt3D::QCircularBuffer::push_back(const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::push_back(const T &value) This function is provided for STL compatibility. It is equivalent to append(\a value). */ -/*! \fn void Qt3D::QCircularBuffer::push_front(const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::push_front(const T &value) This function is provided for STL compatibility. It is equivalent to prepend(\a value). */ -/*! \fn void Qt3D::QCircularBuffer::pop_back() +/*! \fn void Qt3DCore::QCircularBuffer::pop_back() This function is provided for STL compatibility. It is equivalent to erase(end() - 1). */ -/*! \fn void Qt3D::QCircularBuffer::pop_front() +/*! \fn void Qt3DCore::QCircularBuffer::pop_front() This function is provided for STL compatibility. It is equivalent to erase(begin()). */ -/*! \fn bool Qt3D::QCircularBuffer::empty() const +/*! \fn bool Qt3DCore::QCircularBuffer::empty() const This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the circular buffer is empty; otherwise returns false. */ -/*! \fn Qt3D::QCircularBuffer::reference Qt3D::QCircularBuffer::front() +/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::front() This function is provided for STL compatibility. It is equivalent to first(). */ -/*! \fn Qt3D::QCircularBuffer::const_reference Qt3D::QCircularBuffer::front() const +/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::front() const \overload */ -/*! \fn Qt3D::QCircularBuffer::reference Qt3D::QCircularBuffer::back() +/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::back() This function is provided for STL compatibility. It is equivalent to last(). */ -/*! \fn Qt3D::QCircularBuffer::const_reference Qt3D::QCircularBuffer::back() const +/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::back() const \overload */ -/*! \fn int Qt3D::QCircularBuffer::refCount() const +/*! \fn int Qt3DCore::QCircularBuffer::refCount() const Returns the number of shallow copies that exist of this circular buffer. */ -/*! \fn Qt3D::QCircularBuffer::append(const T &value) +/*! \fn Qt3DCore::QCircularBuffer::append(const T &value) Inserts \a value at the end of the circular buffer. If the circular buffer is full, then the oldest element is overwritten. @@ -386,7 +386,7 @@ \sa operator<<(), operator+=(), prepend(), insert() */ -/*! \fn const T &Qt3D::QCircularBuffer::at(int i) const +/*! \fn const T &Qt3DCore::QCircularBuffer::at(int i) const Returns the item at index position \a i in the circular buffer. @@ -396,7 +396,7 @@ \sa value(), operator[]() */ -/*! \fn T &Qt3D::QCircularBuffer::operator[](int i) +/*! \fn T &Qt3DCore::QCircularBuffer::operator[](int i) Returns the item at index position \a i as a modifiable reference. @@ -409,14 +409,14 @@ \sa at(), value() */ -/*! \fn const T &Qt3D::QCircularBuffer::operator[](int i) const +/*! \fn const T &Qt3DCore::QCircularBuffer::operator[](int i) const \overload Same as at(\a i). */ -/*! \fn int Qt3D::QCircularBuffer::capacity() const +/*! \fn int Qt3DCore::QCircularBuffer::capacity() const Returns the maximum number of elements that can be stored in the circular buffer. @@ -424,7 +424,7 @@ \sa setCapacity(), size() */ -/*! \fn void Qt3D::QCircularBuffer::clear() +/*! \fn void Qt3DCore::QCircularBuffer::clear() Removes all elements from the circular buffer so that the size is zero. The capacity is unchanged. @@ -432,7 +432,7 @@ \sa isEmpty() */ -/*! \fn bool Qt3D::QCircularBuffer::contains(const T &value) const +/*! \fn bool Qt3DCore::QCircularBuffer::contains(const T &value) const Returns true if the circular buffer contains an occurrence of \a value; otherwise returns false. @@ -443,7 +443,7 @@ \sa indexOf(), count() */ -/*! \fn int Qt3D::QCircularBuffer::count(const T &value) const +/*! \fn int Qt3DCore::QCircularBuffer::count(const T &value) const Returns the number of occurrences of \a value in the circular buffer. @@ -453,16 +453,16 @@ \sa contains(), indexOf() */ -/*! \fn int Qt3D::QCircularBuffer::count() const +/*! \fn int Qt3DCore::QCircularBuffer::count() const \overload Same as size(). */ -/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::data() +/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::data() - Returns a Qt3D::QCircularBuffer::array_range describing the internal array of data. If + Returns a Qt3DCore::QCircularBuffer::array_range describing the internal array of data. If the circular buffer is non-linearized, then this function causes it to be linearized. If the cost of linearisation is too high for your use case, then you should consider using the dataOne() and dataTwo() functions instead. @@ -473,7 +473,7 @@ \sa constData(), dataOne(), dataTwo(), isLinearised() */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::data() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::data() const \overload @@ -482,9 +482,9 @@ constness. */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constData() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constData() const - Returns a Qt3D::QCircularBuffer::const_array_range describing the internal array of + Returns a Qt3DCore::QCircularBuffer::const_array_range describing the internal array of data. If the circular buffer is non-linearized then the pointer and array size @@ -497,14 +497,14 @@ \sa data(), constDataOne(), constDataTwo(), isLinearised() */ -/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::dataOne() +/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataOne() - Returns a Qt3D::QCircularBuffer::array_range describing the first internal array of + Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then this function is equivalent to calling data(). If the circular buffer is non-linearized then the returned array range will describe a subset of the data contained in the circular buffer. This subset will consist of the earliest (lowest index) items - in the buffer. To obtain a Qt3D::QCircularBuffer::array_range for the remainder + in the buffer. To obtain a Qt3DCore::QCircularBuffer::array_range for the remainder of the data, use the dataTwo() function. If the circular buffer is empty, then the pointer and array size returned @@ -513,22 +513,22 @@ \sa constDataOne(), dataTwo(), data(), isLinearised() */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::dataOne() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataOne() const \overload - Unlike data() this function always returns a valid Qt3D::QCircularBuffer::const_array_range + Unlike data() this function always returns a valid Qt3DCore::QCircularBuffer::const_array_range (unless the circular buffer is empty). */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constDataOne() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataOne() const - Returns a Qt3D::QCircularBuffer::const_array_range describing the first internal array of + Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then this function is equivalent to calling constData(). If the circular buffer is non-linearized, then the returned array range will describe a subset of the data contained in the circular buffer. This subset will consist of the earliest (lowest index) items - in the buffer. To obtain a Qt3D::QCircularBuffer::const_array_range for the remainder + in the buffer. To obtain a Qt3DCore::QCircularBuffer::const_array_range for the remainder of the data, use the constDataTwo() function. If the circular buffer is empty, then the pointer and array size returned @@ -537,9 +537,9 @@ \sa dataOne(), constDataTwo(), constData(), isLinearised() */ -/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::dataTwo() +/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataTwo() - Returns a Qt3D::QCircularBuffer::array_range describing the first internal array of + Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then the pointer and array size returned will both be 0 since all the data will be contained in the array described by calling the dataOne() function. @@ -547,14 +547,14 @@ \sa dataOne(), constDataTwo(), data(), isLinearised() */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::dataTwo() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataTwo() const \overload */ -/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constDataTwo() const +/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataTwo() const - Returns a Qt3D::QCircularBuffer::const_array_range describing the first internal array of + Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then the pointer and array size returned will both be 0 since all the data will be contained in the array described by calling the dataOne() function. @@ -562,7 +562,7 @@ \sa constDataOne(), dataTwo(), constData(), isLinearised() */ -/*! \fn bool Qt3D::QCircularBuffer::endsWith(const T &value) const +/*! \fn bool Qt3DCore::QCircularBuffer::endsWith(const T &value) const Returns true if this circular buffer is not empty and its last item is equal to \a value; otherwise returns false. @@ -570,7 +570,7 @@ \sa isEmpty(), last(), startsWith() */ -/*! \fn QCircularBuffer<T>& Qt3D::QCircularBuffer::fill(const T &value, int size = -1) +/*! \fn QCircularBuffer<T>& Qt3DCore::QCircularBuffer::fill(const T &value, int size = -1) Assigns \a value to all items in the circular buffer. If \a size is different from -1 (the default), the circular buffer is resized to size \a @@ -584,7 +584,7 @@ \sa resize() */ -/*! \fn T &Qt3D::QCircularBuffer::first() +/*! \fn T &Qt3DCore::QCircularBuffer::first() Returns a reference to the first item in the circular buffer. This function assumes that the circular buffer isn't empty. @@ -592,12 +592,12 @@ \sa last(), isEmpty() */ -/*! \fn const T &Qt3D::QCircularBuffer::first() const +/*! \fn const T &Qt3DCore::QCircularBuffer::first() const \overload */ -/*! \fn int Qt3D::QCircularBuffer::freeSize() const +/*! \fn int Qt3DCore::QCircularBuffer::freeSize() const Returns the number of items that can be added to the circular buffer without causing the earliest item to be overwritten. It is equivalent @@ -606,7 +606,7 @@ \sa sizeAvailable(), capacity(), isEmpty(), isFull(), size() */ -/*! \fn static QCircularBuffer<T> Qt3D::QCircularBuffer::fromList(const QList<T>& list) +/*! \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromList(const QList<T>& list) Returns a QCircularBuffer object with the data contained in \a list. The capacity and size of the circular buffer will be equal to the size of @@ -618,7 +618,7 @@ \sa fromVector(), toList(), toVector() */ -/*! \fn static QCircularBuffer<T> Qt3D::QCircularBuffer::fromVector(const QVector<T>& vector) +/*! \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromVector(const QVector<T>& vector) Returns a QCircularBuffer object with the data contained in \a vector. The capacity and size of the circular buffer will be equal to the size of @@ -627,7 +627,7 @@ \sa fromList(), toVector(), toList() */ -/*! \fn int Qt3D::QCircularBuffer::indexOf(const T &value, int from = 0) const +/*! \fn int Qt3DCore::QCircularBuffer::indexOf(const T &value, int from = 0) const Returns the index position of the first occurrence of \a value in the circular buffer, searching forward from index position \a from. @@ -642,7 +642,7 @@ \sa lastIndexOf(), contains() */ -/*! \fn void Qt3D::QCircularBuffer::insert(int i, const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::insert(int i, const T &value) Inserts \a value at index position \a i in the circular buffer. If \a i is 0, the value is prepended to the circular buffer. If \a i @@ -674,7 +674,7 @@ \sa append(), prepend(), remove() */ -/*! \fn void Qt3D::QCircularBuffer::insert(int i, int count, const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::insert(int i, int count, const T &value) \overload @@ -708,7 +708,7 @@ \sa append(), prepend(), remove() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::insert(const_iterator before, int count, const T &value) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, int count, const T &value) \overload @@ -719,7 +719,7 @@ \sa append(), prepend(), remove() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::insert(const_iterator before, const T &value) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, const T &value) \overload @@ -729,21 +729,21 @@ \sa append(), prepend(), remove() */ -/*! \fn bool Qt3D::QCircularBuffer::isEmpty() const +/*! \fn bool Qt3DCore::QCircularBuffer::isEmpty() const Returns true if the circular buffer has size 0; otherwise returns false. \sa capacity(), resize(), setCapacity(), size() */ -/*! \fn bool Qt3D::QCircularBuffer::isFull() const +/*! \fn bool Qt3DCore::QCircularBuffer::isFull() const Returns true if the circular buffer is full ie if size() == capacity(); otherwise returns false. \sa capacity(), resize(), setCapacity(), size() */ -/*! \fn bool Qt3D::QCircularBuffer::isLinearised() const +/*! \fn bool Qt3DCore::QCircularBuffer::isLinearised() const Returns true if the circular buffer is linearized; otherwise returns false. @@ -801,7 +801,7 @@ (perhaps for a plain C++ function call) then you can use the data() function. If the circular buffer is non-linearized, then the data() function will linearize it for you before returning a - Qt3D::QCircularBuffer::array_range describing the array. + Qt3DCore::QCircularBuffer::array_range describing the array. To prevent the cost of the linearisation process, you can instead call the dataOne() and dataTwo() functions to obtain the two arrays @@ -817,7 +817,7 @@ \sa linearise(), data(), dataOne(), dataTwo() */ -/*! \fn T &Qt3D::QCircularBuffer::last() +/*! \fn T &Qt3DCore::QCircularBuffer::last() Returns a reference to the last item in the circular buffer. This function assumes that the circular buffer isn't empty. @@ -825,12 +825,12 @@ \sa first(), isEmpty() */ -/*! \fn const T &Qt3D::QCircularBuffer::last() const +/*! \fn const T &Qt3DCore::QCircularBuffer::last() const \overload */ -/*! \fn int Qt3D::QCircularBuffer::lastIndexOf(const T &value, int from = -1) const +/*! \fn int Qt3DCore::QCircularBuffer::lastIndexOf(const T &value, int from = -1) const Returns the index position of the last occurrence of the value \a value in the circular buffer, searching backward from index position \a @@ -846,7 +846,7 @@ \sa indexOf() */ -/*! \fn void Qt3D::QCircularBuffer::linearise() +/*! \fn void Qt3DCore::QCircularBuffer::linearise() Linearizes the internal representation of the circular buffer such that all items are stored in a single contiguous array. @@ -856,7 +856,7 @@ \sa isLinearised() */ -/*! \fn void Qt3D::QCircularBuffer::prepend(const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::prepend(const T &value) Inserts \a value at the beginning of the circular buffer. If the circular buffer is full, then the highest index item is overwritten. @@ -870,14 +870,14 @@ \sa operator<<(), operator+=(), append(), insert() */ -/*! \fn void Qt3D::QCircularBuffer::remove(int i) +/*! \fn void Qt3DCore::QCircularBuffer::remove(int i) Removes the element at index position \a i. \sa insert(), replace(), fill() */ -/*! \fn void Qt3D::QCircularBuffer::remove(int i, int count) +/*! \fn void Qt3DCore::QCircularBuffer::remove(int i, int count) \overload @@ -887,7 +887,7 @@ \sa insert(), replace(), fill() */ -/*! \fn void Qt3D::QCircularBuffer::replace(int i, const T &value) +/*! \fn void Qt3DCore::QCircularBuffer::replace(int i, const T &value) Replaces the item at index position \a i with \a value. @@ -897,7 +897,7 @@ \sa operator[](), remove() */ -/*! \fn void Qt3D::QCircularBuffer::reserve(int capacity) +/*! \fn void Qt3DCore::QCircularBuffer::reserve(int capacity) Sets the capacity of the circular buffer to \a capacity. It is a synonym for setCapacity(). @@ -905,7 +905,7 @@ \sa setCapacity() */ -/*! \fn void Qt3D::QCircularBuffer::resize(int size) +/*! \fn void Qt3DCore::QCircularBuffer::resize(int size) Changes the size of the circular buffer to \a size which must be > 0 and <= capacity(). If \a size is less than the old size, then the highest indexed @@ -916,21 +916,21 @@ \sa size(), insert(), remove(), capacity(), setCapacity() */ -/*! \fn void Qt3D::QCircularBuffer::setCapacity(int capacity) +/*! \fn void Qt3DCore::QCircularBuffer::setCapacity(int capacity) Sets the capacity of the circular buffer to \a capacity. \sa reserve(), capacity() */ -/*! \fn int Qt3D::QCircularBuffer::size() const +/*! \fn int Qt3DCore::QCircularBuffer::size() const Returns the number of items in the circular buffer. \sa sizeAvailable(), capacity(), resize() */ -/*! \fn int Qt3D::QCircularBuffer::sizeAvailable() const +/*! \fn int Qt3DCore::QCircularBuffer::sizeAvailable() const Returns the number of items that can be added to the circular buffer without causing the earliest item to be overwritten. It is equivalent @@ -939,7 +939,7 @@ \sa capacity(), isEmpty(), isFull(), size(), freeSize() */ -/*! \fn void Qt3D::QCircularBuffer::squeeze() +/*! \fn void Qt3DCore::QCircularBuffer::squeeze() Releases any unused memory from the circular buffer. It is equivalent to calling setCapacity(size()). @@ -947,7 +947,7 @@ \sa setCapacity(), size(), resize(), sizeAvailable() */ -/*! \fn bool Qt3D::QCircularBuffer::startsWith(const T &value) const +/*! \fn bool Qt3DCore::QCircularBuffer::startsWith(const T &value) const Returns true if the circular buffer is not empty and its first item is equal to \a value; otherwise returns false. @@ -955,7 +955,7 @@ \sa isEmpty(), first(), endsWith() */ -/*! \fn QList<T> Qt3D::QCircularBuffer::toList() const +/*! \fn QList<T> Qt3DCore::QCircularBuffer::toList() const Returns a QList object with the data contained in this QCircularBuffer. @@ -966,14 +966,14 @@ \sa fromList(), toVector() */ -/*! \fn QVector<T> Qt3D::QCircularBuffer::toVector() const +/*! \fn QVector<T> Qt3DCore::QCircularBuffer::toVector() const Returns a QVector object with the data contained in this QCircularBuffer. \sa fromVector(), toList() */ -/*! \fn T Qt3D::QCircularBuffer::value(int i) const +/*! \fn T Qt3DCore::QCircularBuffer::value(int i) const Returns the value at index position \a i in the circular buffer. @@ -985,7 +985,7 @@ \sa at(), operator[]() */ -/*! \fn T Qt3D::QCircularBuffer::value(int i, const T &defaultValue) const +/*! \fn T Qt3DCore::QCircularBuffer::value(int i, const T &defaultValue) const \overload @@ -993,7 +993,7 @@ \a defaultValue. */ -/*! \fn bool Qt3D::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if the circular buffer \a lhs is equal to \a rhs; otherwise returns false. @@ -1007,7 +1007,7 @@ \sa operator!=() */ -/*! \fn bool Qt3D::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if the circular buffer \a lhs is not equal to \a rhs; otherwise returns false. @@ -1021,7 +1021,7 @@ \sa operator==() */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const T &other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const T &other) Appends the item \a other to this circular buffer and returns a reference to this circular buffer. @@ -1029,7 +1029,7 @@ \sa operator+(), operator<<(), append() */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QCircularBuffer<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer<T>& other) \overload @@ -1039,17 +1039,17 @@ \sa operator+(), operator<<(), append() */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QVector<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QVector<T>& other) \overload */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QList<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QList<T>& other) \overload */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const T &other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const T &other) Appends the item \a other to this circular buffer and returns a reference to this circular buffer. @@ -1057,7 +1057,7 @@ \sa operator+(), operator+=(), append() */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QCircularBuffer<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer<T>& other) \overload @@ -1067,96 +1067,96 @@ \sa operator+(), operator+=(), append() */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QVector<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QVector<T>& other) \overload */ -/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QList<T>& other) +/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QList<T>& other) \overload */ -/*! \fn Qt3D::QCircularBuffer<T> Qt3D::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs) +/*! \fn Qt3DCore::QCircularBuffer<T> Qt3DCore::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs) Returns a circular buffer object with capacity of lhs.size() + rhs.size() containing the items from \a lhs followed by the items from \a rhs. - \sa Qt3D::QCircularBuffer::operator+=() + \sa Qt3DCore::QCircularBuffer::operator+=() */ -/*! \fn void Qt3D::swap(QCircularBuffer<T> &lhs, QCircularBuffer<T> &rhs) +/*! \fn void Qt3DCore::swap(QCircularBuffer<T> &lhs, QCircularBuffer<T> &rhs) Swaps the contents of the circular buffer \a lhs with the contents of \a rhs. */ -/*! \fn bool Qt3D::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if \a lhs is lexographically less than \a rhs. This is equivalent to calling \c{return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end())}. */ -/*! \fn bool Qt3D::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if \a rhs is lexographically less than \a lhs. */ -/*! \fn bool Qt3D::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if \a lhs is lexographically less than or equal to \a rhs. */ -/*! \fn bool Qt3D::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/*! \fn bool Qt3DCore::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns true if \a lhs is lexographically less than or equal to \a rhs. */ -/*! \typedef Qt3D::QCircularBuffer::Iterator +/*! \typedef Qt3DCore::QCircularBuffer::Iterator - Qt-style synonym for Qt3D::QCircularBuffer::iterator. + Qt-style synonym for Qt3DCore::QCircularBuffer::iterator. */ -/*! \typedef Qt3D::QCircularBuffer::ConstIterator +/*! \typedef Qt3DCore::QCircularBuffer::ConstIterator - Qt-style synonym for Qt3D::QCircularBuffer::const_iterator. + Qt-style synonym for Qt3DCore::QCircularBuffer::const_iterator. */ -/*! \typedef Qt3D::QCircularBuffer::const_pointer +/*! \typedef Qt3DCore::QCircularBuffer::const_pointer Typedef for const T *. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::const_reference +/*! \typedef Qt3DCore::QCircularBuffer::const_reference Typedef for T &. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::difference_type +/*! \typedef Qt3DCore::QCircularBuffer::difference_type Typedef for ptrdiff_t. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::pointer +/*! \typedef Qt3DCore::QCircularBuffer::pointer Typedef for T *. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::reference +/*! \typedef Qt3DCore::QCircularBuffer::reference Typedef for T &. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::size_type +/*! \typedef Qt3DCore::QCircularBuffer::size_type Typedef for int. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::value_type +/*! \typedef Qt3DCore::QCircularBuffer::value_type Typedef for T. Provided for STL compatibility. */ -/*! \typedef Qt3D::QCircularBuffer::array_range +/*! \typedef Qt3DCore::QCircularBuffer::array_range Typedef for QPair<T*,int>. The first element is a pointer to the first element of an array of T. The second element is the number @@ -1165,62 +1165,62 @@ \sa data(), dataOne(), dataTwo() */ -/*! \typedef Qt3D::QCircularBuffer::const_array_range +/*! \typedef Qt3DCore::QCircularBuffer::const_array_range Typedef for QPair<const T*,int>. The first element is a pointer to the first element of an array of const T. The second element is the number of elements in the array. */ -/*! \typedef Qt3D::QCircularBuffer::ArrayRange +/*! \typedef Qt3DCore::QCircularBuffer::ArrayRange - Qt-style synonym for Qt3D::QCircularBuffer::array_range. + Qt-style synonym for Qt3DCore::QCircularBuffer::array_range. */ -/*! \typedef Qt3D::QCircularBuffer::ConstArrayRange +/*! \typedef Qt3DCore::QCircularBuffer::ConstArrayRange - Qt-style synonym for Qt3D::QCircularBuffer::const_array_range. + Qt-style synonym for Qt3DCore::QCircularBuffer::const_array_range. */ -/*! \class Qt3D::QCircularBuffer::iterator +/*! \class Qt3DCore::QCircularBuffer::iterator \inmodule Qt3DCore - \brief The Qt3D::QCircularBuffer::iterator class provides an STL-style non-const iterator for QCircularBuffer. + \brief The Qt3DCore::QCircularBuffer::iterator class provides an STL-style non-const iterator for QCircularBuffer. QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style Iterators}. - \sa Qt3D::QCircularBuffer::begin(), Qt3D::QCircularBuffer::end(), - Qt3D::QCircularBuffer::const_iterator + \sa Qt3DCore::QCircularBuffer::begin(), Qt3DCore::QCircularBuffer::end(), + Qt3DCore::QCircularBuffer::const_iterator */ -/*! \typedef Qt3D::QCircularBuffer::iterator::iterator_category +/*! \typedef Qt3DCore::QCircularBuffer::iterator::iterator_category A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ -/*! \typedef Qt3D::QCircularBuffer::iterator::difference_type +/*! \typedef Qt3DCore::QCircularBuffer::iterator::difference_type \internal */ -/*! \typedef Qt3D::QCircularBuffer::iterator::value_type +/*! \typedef Qt3DCore::QCircularBuffer::iterator::value_type \internal */ -/*! \typedef Qt3D::QCircularBuffer::iterator::pointer +/*! \typedef Qt3DCore::QCircularBuffer::iterator::pointer \internal */ -/*! \typedef Qt3D::QCircularBuffer::iterator::reference +/*! \typedef Qt3DCore::QCircularBuffer::iterator::reference \internal */ -/*! \fn Qt3D::QCircularBuffer::iterator::iterator() +/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator() Constructs an uninitialized iterator. @@ -1228,15 +1228,15 @@ on an uninitialized iterator. Use operator=() to assign a value to it before using it. - \sa Qt3D::QCircularBuffer::begin() Qt3D::QCircularBuffer::end() + \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end() */ -/*! \fn Qt3D::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index) +/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index) \internal */ -/*! \fn T &Qt3D::QCircularBuffer::iterator::operator*() const +/*! \fn T &Qt3DCore::QCircularBuffer::iterator::operator*() const Returns a modifiable reference to the current item. @@ -1246,14 +1246,14 @@ \sa operator->() */ -/*! \fn T *Qt3D::QCircularBuffer::iterator::operator->() const +/*! \fn T *Qt3DCore::QCircularBuffer::iterator::operator->() const Returns a pointer to the current item. \sa operator*() */ -/*! \fn T &Qt3D::QCircularBuffer::iterator::operator[](int j) const +/*! \fn T &Qt3DCore::QCircularBuffer::iterator::operator[](int j) const Returns a modifiable reference to the item at position *this + \a{j}. @@ -1265,7 +1265,7 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator==(const iterator &other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator==(const iterator &other) const Returns true if \a other points to the same item as this iterator; otherwise returns false. @@ -1274,7 +1274,7 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator!=(const iterator &other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator!=(const iterator &other) const Returns true if \a other points to a different item than this iterator; otherwise returns false. @@ -1283,45 +1283,45 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator<(const iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator<(const iterator& other) const Returns true if the item pointed to by this iterator occurs before the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator<=(const iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator<=(const iterator& other) const Returns true if the item pointed to by this iterator occurs before or at the same position as the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator>(const iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator>(const iterator& other) const Returns true if the item pointed to by this iterator occurs after the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::iterator::operator>=(const iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::iterator::operator>=(const iterator& other) const Returns true if the item pointed to by this iterator occurs after or at the same position as the item pointed to by the \a other iterator. */ -/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::QCircularBuffer::iterator::operator++() +/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator++() The prefix ++ operator (\c{++it}) advances the iterator to the next item in the circular buffer and returns an iterator to the new current item. - Calling this function on Qt3D::QCircularBuffer::end() leads to undefined results. + Calling this function on Qt3DCore::QCircularBuffer::end() leads to undefined results. \sa operator--() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator++(int) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int) \overload @@ -1330,17 +1330,17 @@ current item. */ -/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::QCircularBuffer::iterator::operator--() +/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator--() The prefix -- operator (\c{--it}) makes the preceding item the current item, and returns an iterator to the new current item. - Calling this function on Qt3D::QCircularBuffer::begin() leads to undefined results. + Calling this function on Qt3DCore::QCircularBuffer::begin() leads to undefined results. \sa operator++() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator--(int) +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator--(int) \overload @@ -1348,7 +1348,7 @@ the current item, and returns an iterator to the previously current item. */ -/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::QCircularBuffer::iterator::operator+=(int j) +/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -1356,7 +1356,7 @@ \sa operator-=(), operator+() */ -/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::QCircularBuffer::iterator::operator-=(int j) +/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -1364,7 +1364,7 @@ \sa operator+=(), operator-() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator+(int j) const +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator+(int j) const Returns an iterator to the item at \a j positions forward from this iterator. (If \a j is negative, the iterator goes backward.) @@ -1372,7 +1372,7 @@ \sa operator-(), operator+=() */ -/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator-(int j) const +/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator-(int j) const Returns an iterator to the item at \a j positions backward from this iterator. (If \a j is negative, the iterator goes forward.) @@ -1380,51 +1380,51 @@ \sa operator+(), operator-=() */ -/*! \fn int Qt3D::QCircularBuffer::iterator::operator-(iterator other) const +/*! \fn int Qt3DCore::QCircularBuffer::iterator::operator-(iterator other) const Returns the number of items between the item pointed to by \a other and the item pointed to by this iterator. */ -/*! \class Qt3D::QCircularBuffer::const_iterator +/*! \class Qt3DCore::QCircularBuffer::const_iterator \inmodule Qt3DCore - \brief The Qt3D::QCircularBuffer::const_iterator class provides an STL-style const iterator for QCircularBuffer. + \brief The Qt3DCore::QCircularBuffer::const_iterator class provides an STL-style const iterator for QCircularBuffer. QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style Iterators}. - \sa Qt3D::QCircularBuffer::constBegin(), Qt3D::QCircularBuffer::constEnd(), - Qt3D::QCircularBuffer::iterator + \sa Qt3DCore::QCircularBuffer::constBegin(), Qt3DCore::QCircularBuffer::constEnd(), + Qt3DCore::QCircularBuffer::iterator */ -/*! \typedef Qt3D::QCircularBuffer::const_iterator::iterator_category +/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::iterator_category A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ -/*! \typedef Qt3D::QCircularBuffer::const_iterator::difference_type +/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::difference_type \internal */ -/*! \typedef Qt3D::QCircularBuffer::const_iterator::value_type +/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::value_type \internal */ -/*! \typedef Qt3D::QCircularBuffer::const_iterator::pointer +/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::pointer \internal */ -/*! \typedef Qt3D::QCircularBuffer::const_iterator::reference +/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::reference \internal */ -/*! \fn Qt3D::QCircularBuffer::const_iterator::const_iterator() +/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator() Constructs an uninitialized const iterator. @@ -1432,29 +1432,29 @@ on an uninitialized iterator. Use operator=() to assign a value to it before using it. - \sa Qt3D::QCircularBuffer::begin() Qt3D::QCircularBuffer::end() + \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator::const_iterator(const iterator &other) +/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator(const iterator &other) \internal */ -/*! \fn const T &Qt3D::QCircularBuffer::const_iterator::operator*() const +/*! \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator*() const Returns a const reference to the current item. \sa operator->() */ -/*! \fn const T *Qt3D::QCircularBuffer::const_iterator::operator->() const +/*! \fn const T *Qt3DCore::QCircularBuffer::const_iterator::operator->() const Returns a pointer to the current item. \sa operator*() */ -/*! \fn const T &Qt3D::QCircularBuffer::const_iterator::operator[](int j) const +/*! \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator[](int j) const Returns a const reference to the item at position *this + \a{j}. @@ -1466,7 +1466,7 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator==(const const_iterator &other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator==(const const_iterator &other) const Returns true if \a other points to the same item as this iterator; otherwise returns false. @@ -1475,7 +1475,7 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator!=(const const_iterator &other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator!=(const const_iterator &other) const Returns true if \a other points to a different item than this iterator; otherwise returns false. @@ -1484,45 +1484,45 @@ */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const Returns true if the item pointed to by this iterator occurs before the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const Returns true if the item pointed to by this iterator occurs before, or at the same position as the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const Returns true if the item pointed to by this iterator occurs after the item pointed to by the \a other iterator. */ /*! - \fn bool Qt3D::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const + \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const Returns true if the item pointed to by this iterator occurs after, or at the same position as the item pointed to by the \a other iterator. */ -/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::QCircularBuffer::const_iterator::operator++() +/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator++() The prefix ++ operator (\c{++it}) advances the iterator to the next item in the circular buffer and returns an iterator to the new current item. - Calling this function on Qt3D::QCircularBuffer::constEnd() leads to undefined results. + Calling this function on Qt3DCore::QCircularBuffer::constEnd() leads to undefined results. \sa operator--() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator++(int) +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator++(int) \overload @@ -1531,17 +1531,17 @@ current item. */ -/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::QCircularBuffer::const_iterator::operator--() +/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator--() The prefix -- operator (\c{--it}) makes the preceding item the current and returns an iterator to the new current item. - Calling this function on Qt3D::QCircularBuffer::constBegin() leads to undefined results. + Calling this function on Qt3DCore::QCircularBuffer::constBegin() leads to undefined results. \sa operator++() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator--(int) +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator--(int) \overload @@ -1549,7 +1549,7 @@ current and returns an iterator to the previously current item. */ -/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::QCircularBuffer::const_iterator::operator+=(int j) +/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -1557,7 +1557,7 @@ \sa operator-=(), operator+() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::QCircularBuffer::const_iterator::operator-=(int j) +/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -1565,7 +1565,7 @@ \sa operator+=(), operator-() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator+(int j) const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator+(int j) const Returns an iterator to the item at \a j positions forward from this iterator. (If \a j is negative, the iterator goes backward.) @@ -1573,7 +1573,7 @@ \sa operator-(), operator+=() */ -/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator-(int j) const +/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator-(int j) const Returns an iterator to the item at \a j positions backward from this iterator. (If \a j is negative, the iterator goes forward.) @@ -1581,7 +1581,7 @@ \sa operator+(), operator-=() */ -/*! \fn int Qt3D::QCircularBuffer::const_iterator::operator-(const_iterator other) const +/*! \fn int Qt3DCore::QCircularBuffer::const_iterator::operator-(const_iterator other) const Returns the number of items between the item pointed to by \a other and the item pointed to by this iterator. diff --git a/src/doc/src/qt3d-examples.qdoc b/src/doc/src/qt3d-examples.qdoc index 4ba413e50..8ff15f122 100644 --- a/src/doc/src/qt3d-examples.qdoc +++ b/src/doc/src/qt3d-examples.qdoc @@ -28,10 +28,10 @@ /*! \page qt3d-examples.html \ingroup all-examples - \title Qt3D Examples - \brief Examples that demonstrate 2D and 3D rendering using Qt3D. + \title Qt 3D Examples + \brief Examples that demonstrate 2D and 3D rendering using Qt 3D. - The following examples demonstrate 2D and 3D rendering using Qt3D. + The following examples demonstrate 2D and 3D rendering using Qt 3D. \section1 QML Examples \annotatedlist qt3d-examples-qml diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index db8785436..23c99f8b0 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -39,17 +39,17 @@ \page qt3d-index.html \title Qt 3D - \e Qt3D provides functionality for near-realtime simulation systems + \e{Qt 3D} 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 C++ modules: + The functionality in Qt 3D is divided into the following C++ modules: \annotatedlist qt3d-modules - Classes, types and functions are declared under the \l [CPP] {Qt3D} namespace. + Classes, types and functions are declared under the \l[CPP]{Qt 3D} namespace. - For Qt Quick applications, Qt3D provides the following QML modules: + For Qt Quick applications, Qt 3D provides the following QML modules: \annotatedlist qt3d-qmlmodules @@ -82,21 +82,21 @@ \section1 Overview - The high level design and motivation for Qt3D is described in the \l {Qt3D - Overview}. The Qt3D Renderer aspect offers support for data-driven - configuration as described in \l {Qt3D Renderer Framegraph}. + The high level design and motivation for Qt3D is described in the \l {Qt 3D + Overview}. The Qt 3D Renderer aspect offers support for data-driven + configuration as described in \l {Qt 3D Renderer Framegraph}. \section1 Reference \list - \li \l {Qt3D Overview} + \li \l {Qt 3D Overview} \li \l {Qt 3D C++ Classes} \li \l {Qt 3D QML Types} - \li \l {Qt3D Examples} + \li \l {Qt 3D Examples} \endlist - \section1 Qt3D Platform Support + \section1 Qt 3D Platform Support - In this Technology Preview Qt3D has the following support for platforms: + In this Technology Preview Qt 3D has the following support for platforms: \list \li Microsoft Windows (win32) - Supported diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index bc9042b46..90bbd5e86 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -113,7 +113,7 @@ \section1 QML Types \section2 Qt 3D Core Module - \generatelist {qmltypesbymodule Qt3D} + \generatelist {qmltypesbymodule Qt3D.Core} \section2 Qt 3D Collision Module \generatelist {qmltypesbymodule Qt3D.Collision} diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index 133f6fd14..c77265ed9 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -36,16 +36,16 @@ /*! \page qt3d-overview.html - \title Qt3D Overview + \title Qt 3D Overview - \brief Qt3D provides C++ and QML APIs to incorporate 3D content into Qt + \brief Qt 3D provides C++ and QML APIs to incorporate 3D content into Qt applications. - Qt3D provides a fully configurable renderer that enables developers to + Qt 3D provides a fully configurable renderer that enables developers to quickly implement any rendering pipeline that they need. Further, Qt3D provides a generic framework for near-realtime simulations beyond rendering. - Qt3D is cleanly separated into a core and any number of \e aspects that can + Qt 3D is cleanly separated into a core and any number of \e aspects that can implement any functionality they wish. The aspects interact with \e components and \e entities to provide some slice of functionality. Examples of aspects include physics, audio, collision, artificial @@ -53,7 +53,7 @@ \section1 Basic 3D Features - Qt3D is a 3D framework that enables the drawing of 3D shapes and moving + Qt 3D is a 3D framework that enables the drawing of 3D shapes and moving them around, as well as moving the camera. It supports the following basic features: @@ -73,7 +73,7 @@ \section2 Materials - Qt3D has a robust and very flexible material system that allows multiple + Qt 3D has a robust and very flexible material system that allows multiple levels of customization. It caters for different rendering approaches on different platforms or OpenGL versions, enables multiple rendering passes with different state sets, provides mechanisms for overriding of parameters @@ -84,19 +84,19 @@ variables in a GLSL shader program that is itself specified in the referenced effect property. - For examples of using materials, see the \l {Qt3D: Materials C++ Example} - and \l {Qt3D: Materials QML Example}. + For examples of using materials, see the \l {Qt 3D: Materials C++ Example} + and \l {Qt 3D: Materials QML Example}. \section2 Shaders - Qt3D supports all of the OpenGL programmable rendering pipeline stages: + Qt 3D supports all of the OpenGL programmable rendering pipeline stages: vertex, tessellation control, tessellation evaluation, geometry, and fragment shaders. Compute shaders are planned for a future release. For examples of using shaders, see the Simple Shaders QML Example, - \l {Qt3D: Tessellation Modes QML Example}, - \l {Qt3D: Shadow Map QML Example}, \l{Qt3D: Wireframe QML Example}, and - \l {Qt3D: Wave QML Example}. + \l {Qt 3D: Tessellation Modes QML Example}, + \l {Qt 3D: Shadow Map QML Example}, \l{Qt 3D: Wireframe QML Example}, and + \l {Qt 3D: Wave QML Example}. \section2 Shadow Mapping @@ -183,7 +183,7 @@ To combine support for both C++ and QML APIs with having a fully configurable renderer, the concept of a \e framegraph was introduced. While a \e scenegraph is a data-driven description of \e what to render, a \l - {Qt3D Renderer Framegraph}{framegraph} is a data-driven description of \e + {Qt 3D Renderer Framegraph}{framegraph} is a data-driven description of \e how to render it. A framegraph enables developers to choose between a simple forward renderer, @@ -191,7 +191,7 @@ gives them control over when to render any transparent objects, and so on. Since this is all configured purely from data, it is very easy to modify even dynamically at runtime without touching any C++ code. It is possible to - extend Qt3D by creating your own framegraphs that implement custom + extend Qt 3D by creating your own framegraphs that implement custom rendering algorithms. \section1 3D Extensions @@ -213,7 +213,7 @@ \section1 Performance - Qt3D is designed to perform well and scale up with the number of available + Qt 3D is designed to perform well and scale up with the number of available CPU cores, because modern hardware improves performance by increasing the numbers of cores rather than base clock speed. Using multiple cores works well, because many tasks are independent of each other. For example, the @@ -221,9 +221,9 @@ the tasks performed by a renderer, except maybe when rendering debug information or statistics. - \section1 Qt3D Architecture + \section1 Qt 3D Architecture - The main use cases of Qt3D are simulating objects in near-realtime and + The main use cases of Qt 3D are simulating objects in near-realtime and rendering the state of those objects onto the screen. The Space Invaders example contains the following objects: @@ -271,8 +271,8 @@ Extending deep and wide inheritance trees usually requires understanding, and agreeing with, the taxonomy used by the original author. Therefore, - Qt3D places focus on aggregation instead of inheritance as the means of - imparting functionality onto an instance of an object. Specifically, Qt3D + Qt 3D places focus on aggregation instead of inheritance as the means of + imparting functionality onto an instance of an object. Specifically, Qt 3D implements an Entity Component System (ECS). \section2 Using an ECS @@ -299,7 +299,7 @@ \image ecs-2.png - The backend of Qt3D implements the \e system part of the ECS paradigm in + The backend of Qt 3D implements the \e system part of the ECS paradigm in the form of \e aspects. An aspect implements the particular vertical slice of the functionality provided to entities by a combination of one or more of their aggregated components. @@ -310,7 +310,7 @@ from it. If an entity does not have those components, the renderer aspect ignores it. - Qt3D builds custom entities by aggregating components that provide + Qt 3D builds custom entities by aggregating components that provide additional capabilities. The Qt3D engine uses aspects to process and update entities with specific components. @@ -329,32 +329,32 @@ temporarily, until the power-up times out. There is no need to create a special one-off subclass for \c PlayerWhoRunsThroughWalls. - \section2 Qt3D ECS Implementation + \section2 Qt 3D ECS Implementation - Qt3D implements ECS as a simple class hierarchy. The Qt3D base class is - Qt3D::QNode, which is a subclass of QObject. Qt3D::QNode adds to QObject the ability to + Qt 3D implements ECS as a simple class hierarchy. The Qt 3D base class is + Qt3DCore::QNode, which is a subclass of QObject. Qt3DCore::QNode adds to QObject the ability to automatically communicate property changes to aspects and an ID that is unique throughout an application. The aspects exist in additional threads - and Qt3D::QNode simplifies the data transfer between the user-facing objects and + and Qt3DCore::QNode simplifies the data transfer between the user-facing objects and the aspects. - Typically, subclasses of Qt3D::QNode provide additional supporting data that is + Typically, subclasses of Qt3DCore::QNode provide additional supporting data that is referenced by components. For example, the QShaderProgram class specifies the GLSL code to be used when rendering a set of entities. \image ecs-1.png - Components in Qt3D are implemented by subclassing Qt3D::QComponent and adding the + Components in Qt 3D are implemented by subclassing Qt3DCore::QComponent and adding the data necessary for the corresponding aspect to do its work. For example, the mesh component is used by the renderer aspect to retrieve the per-vertex data that should be sent down the OpenGL pipeline. - Finally, Qt3D::QEntity is simply an object that can aggregate zero or more - Qt3D::QComponent instances. + Finally, Qt3DCore::QEntity is simply an object that can aggregate zero or more + Qt3DCore::QComponent instances. - \section1 Extending Qt3D + \section1 Extending Qt 3D - Adding functionality to Qt3D, either as part of Qt or specific to your + Adding functionality to Qt 3D, either as part of Qt or specific to your own applications to benefit from the multi-threaded back-end consists of the following tasks: @@ -365,17 +365,18 @@ \li Subclass QAbstractAspect and implement the subsystem functionality. \endlist - \section1 Qt3D Task-Based Engine + \section1 Qt 3D Task-Based Engine - In Qt3D, aspects are asked in each frame for a set of \e tasks to execute + In Qt 3D, aspects are asked in each frame for a set of \e tasks to execute along with the \e dependencies between them. The tasks are distributed across all the configured cores by a scheduler to improve performance. - \section1 Qt3D's Aspects + \section1 Qt 3D's Aspects - By default Qt3D provides the Qt3DRenderer and Qt3DInput aspects. The + By default Qt 3D provides the Qt3DRender and Qt3DInput aspects. The components and other supporting classes provided by these aspects are discussed in the documentation for those modules. Additional aspects providing more capabilities will be added in future - versions of Qt3D. + versions of Qt 3D. +*/ diff --git a/src/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc index 6c7151128..84ee787db 100644 --- a/src/doc/src/qt3dcollision-module.qdoc +++ b/src/doc/src/qt3dcollision-module.qdoc @@ -27,8 +27,8 @@ /*! \module Qt3DCollision - \title Qt3D Collision C++ Classes - \brief The Qt3D Collision module enables collision detection. + \title Qt 3D Collision C++ Classes + \brief The Qt 3D Collision module enables collision detection. \ingroup modules \ingroup qt3d-modules \qtvariable 3dcollision @@ -57,7 +57,7 @@ /*! \qmlmodule Qt3D.Collision 2.0 - \title Qt3D Collision QML Types + \title Qt 3D Collision QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules diff --git a/src/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc index c46d577dd..8560dd000 100644 --- a/src/doc/src/qt3dinput-module.qdoc +++ b/src/doc/src/qt3dinput-module.qdoc @@ -27,8 +27,8 @@ /*! \module Qt3DInput - \title Qt3D Input C++ Classes - \brief The Qt3D Input module provides classes for handling user input in + \title Qt 3D Input C++ Classes + \brief The Qt 3D Input module provides classes for handling user input in applications using Qt3D. \ingroup modules @@ -58,11 +58,11 @@ /*! \qmlmodule Qt3D.Input 2.0 - \title Qt3D Input QML Types + \title Qt 3D Input QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules - \brief Provides QML types for Qt3D user input. + \brief Provides QML types for Qt 3D user input. To import and use the module's QML types, use the following statement: diff --git a/src/doc/src/qt3dlogic-module.qdoc b/src/doc/src/qt3dlogic-module.qdoc index f43eb44e2..20850b891 100644 --- a/src/doc/src/qt3dlogic-module.qdoc +++ b/src/doc/src/qt3dlogic-module.qdoc @@ -27,8 +27,8 @@ /*! \module Qt3DLogic - \title Qt3D Logic C++ Classes - \brief The Qt3D Logic module enables synchronizing frames with the Qt 3D + \title Qt 3D Logic C++ Classes + \brief The Qt 3D Logic module enables synchronizing frames with the Qt 3D backend. \ingroup modules \ingroup qt3d-modules @@ -58,7 +58,7 @@ /*! \qmlmodule Qt3D.Logic 2.0 - \title Qt3D Logic QML Types + \title Qt 3D Logic QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules diff --git a/src/doc/src/qt3drender-framegraph.qdoc b/src/doc/src/qt3drender-framegraph.qdoc index 52a4e2227..0f5fd67af 100644 --- a/src/doc/src/qt3drender-framegraph.qdoc +++ b/src/doc/src/qt3drender-framegraph.qdoc @@ -36,14 +36,14 @@ /*! \page qt3drender-framegraph.html - \title Qt3D Render Framegraph + \title Qt 3D Render Framegraph \brief A framegraph is the data structure that controls how a scene is rendered. - The Qt3D Render aspect allows for the rendering algorithm to be entirely + The Qt 3D Render aspect allows for the rendering algorithm to be entirely data-driven. The controlling data structure is known as the \e framegraph. - Similar to how the Qt3D ECS (entity component system) allows you to define + Similar to how the Qt 3D ECS (entity component system) allows you to define a so-called Scenegraph by building a scene from a tree of Entities and Components, the framegraph is also a tree structure but one used for a different purpose. Namely, controlling \e how the scene is rendered. @@ -83,7 +83,7 @@ Obviously if you just want to render a simple cube onscreen you may think this is overkill. However, as soon as you want to start doing slightly more - complex scenes this comes in handy. For the common cases, Qt3D provides + complex scenes this comes in handy. For the common cases, Qt 3D provides some example framegraphs that are ready to use out of the box. We will demonstrate the flexibility of the framegraph concept by presenting a few @@ -91,7 +91,7 @@ Please note that unlike the Scenegraph which is composed of Entities and Components, the framegraph is only composed of nested nodes which are all - subclasses of Qt3D::QFrameGraphNode. This is because the framegraph nodes + subclasses of Qt3DRender::QFrameGraphNode. This is because the framegraph nodes are not simulated objects in our virtual world, but rather supporting information. @@ -112,13 +112,13 @@ In order to construct a correctly functioning framegraph tree, you should know a few rules about how it is traversed and how to feed it to - the Qt3D renderer. + the Qt 3D renderer. \section2 Setting the Framegraph The FrameGraph tree should be assigned to the activeFrameGraph property of a QFrameGraph component, itself being a component of the root entity in the - Qt3D scene. This is what makes it the active framegraph for the renderer. + Qt 3D scene. This is what makes it the active framegraph for the renderer. Of course, since this is a QML property binding, the active framegraph (or parts of it) can be changed on the fly at runtime. For example, if you want to use different rendering approaches for indoor and outdoor scenes or to @@ -148,14 +148,14 @@ \section2 How the Framegraph Is Used \list - \li The Qt3D renderer performs a \e{depth first traversal} of the + \li The Qt 3D renderer performs a \e{depth first traversal} of the framegraph tree. Note that, because the traversal is depth first, the \e {order in which you define nodes is important}. \li When the renderer reaches a leaf node of the framegraph, it collects together all of the state specified by the path from the leaf node to the root node. This defines the state used to render a section of the frame. If you are interested in the internals of - Qt3D, this collection of state is called a \e RenderView. + Qt 3D, this collection of state is called a \e RenderView. \li Given the configuration contained in a RenderView, the renderer collects together all of the Entities in the Scenegraph to be rendered, and from them builds a set of \e RenderCommands and @@ -168,7 +168,7 @@ \endlist At its heart, the framegraph is a data-driven method for configuring the - Qt3D renderer. Due to its data-driven nature, we can change configuration + Qt 3D renderer. Due to its data-driven nature, we can change configuration at runtime, allow non-C++ developers or designers to change the structure of a frame, and try out new rendering approaches without having to write thousands of lines of boiler plate code. @@ -357,12 +357,12 @@ used as the root of the FrameGraph as that would result in a call to clear the whole screen for each of our viewports. - Although the declaration order of the FrameGraph is important, Qt3D is able + Although the declaration order of the FrameGraph is important, Qt 3D is able to process each RenderView in parallel as each RenderView is independent of the others for the purposes of generating a set of RenderCommands to be submitted whilst the RenderView's state is in effect. - Qt3D uses a task-based approach to parallelism which naturally scales up + Qt 3D uses a task-based approach to parallelism which naturally scales up with the number of available cores. This is shown in the following diagram for the previous example. @@ -497,17 +497,17 @@ \li Use different FrameGraph trees depending on the nature of what you need to render for a particular region of the scene \li Implement a new rendering technique without having to - modify Qt3D's internals + modify Qt 3D's internals \endlist \section1 Conclusion We have introduced the FrameGraph and the node types that compose it. We then went on to discuss a few examples to illustrate the framegraph - building rules and how the Qt3D engine uses the framegraph behind the + building rules and how the Qt 3D engine uses the framegraph behind the scenes. By now you should have a pretty good overview of the FrameGraph and how it can be used (perhaps to add an \l {early z-fill pass} to a forward renderer). Also you should always keep in mind that the FrameGraph is a tool for you to use so that you are not tied down to the provided - renderer and materials that Qt3D provides out of the box. + renderer and materials that Qt 3D provides out of the box. */ diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index aa4dac44f..bae6217fd 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -36,14 +36,14 @@ /*! \module Qt3DRender - \title Qt3D Render C++ Classes - \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. + \title Qt 3D Render C++ Classes + \brief The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt3D. \ingroup modules \ingroup qt3d-modules \qtvariable 3drender - The Qt3D Render module provides an aspect, components, and other supporting types necessary + The Qt 3D Render module provides an aspect, components, and other supporting types necessary to implement 2D and 3D rendering as part of the Qt3D framework. To use classes from this module, add this directive into the C++ files: @@ -62,13 +62,13 @@ \section1 Overview - The Qt3D Render aspect offers support for data-driven configuration as described + The Qt 3D Render aspect offers support for data-driven configuration as described in \l {Qt3D Render Framegraph}. \section1 Reference \list - \li \l {Qt3D Render C++ Classes} - \li \l {Qt3D Examples} + \li \l {Qt 3D Render C++ Classes} + \li \l {Qt 3D Examples} \endlist */ @@ -82,11 +82,11 @@ /*! \qmlmodule Qt3D.Render 2.0 - \title Qt3D Render QML Types + \title Qt 3D Render QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules - \brief Provides Qt3D QML types for rendering. + \brief Provides Qt 3D QML types for rendering. To import and use the module's QML types, use the following statement: diff --git a/src/quick3d/quick3d/items/quick3dconfiguration.cpp b/src/quick3d/quick3d/items/quick3dconfiguration.cpp index 70546eb5f..4b31e08c7 100644 --- a/src/quick3d/quick3d/items/quick3dconfiguration.cpp +++ b/src/quick3d/quick3d/items/quick3dconfiguration.cpp @@ -51,7 +51,7 @@ namespace Quick { /*! \qmltype Configuration - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 */ Quick3DConfiguration::Quick3DConfiguration(QObject *parent) diff --git a/src/quick3d/quick3d/items/quick3dentity.cpp b/src/quick3d/quick3d/items/quick3dentity.cpp index b0b165679..9fdbe1ce9 100644 --- a/src/quick3d/quick3d/items/quick3dentity.cpp +++ b/src/quick3d/quick3d/items/quick3dentity.cpp @@ -45,7 +45,7 @@ namespace Quick { /*! \qmltype Entity \inherits Node - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 */ diff --git a/src/quick3d/quick3d/items/quick3dentityloader.cpp b/src/quick3d/quick3d/items/quick3dentityloader.cpp index 44b39a8da..f9a3ea7e4 100644 --- a/src/quick3d/quick3d/items/quick3dentityloader.cpp +++ b/src/quick3d/quick3d/items/quick3dentityloader.cpp @@ -89,7 +89,7 @@ private: /*! \qmltype EntityLoader - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 */ Quick3DEntityLoader::Quick3DEntityLoader(QNode *parent) diff --git a/src/quick3d/quick3d/items/quick3dnode.cpp b/src/quick3d/quick3d/items/quick3dnode.cpp index 6658f6916..f8228758d 100644 --- a/src/quick3d/quick3d/items/quick3dnode.cpp +++ b/src/quick3d/quick3d/items/quick3dnode.cpp @@ -44,7 +44,7 @@ namespace Quick { /*! \qmltype Node - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 \brief A base QML type that other types inherit. It cannot be directly diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp index 65948aa3c..f4021b999 100644 --- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp +++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp @@ -223,7 +223,7 @@ void Quick3DNodeInstantiatorPrivate::makeModel() /*! \qmltype NodeInstantiator \instantiates Quick3DNodeInstantiator - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \brief Dynamically creates nodes. \since 5.5 diff --git a/src/quick3d/quick3d/items/quick3dtransform.cpp b/src/quick3d/quick3d/items/quick3dtransform.cpp index f52051bd3..e708cb04f 100644 --- a/src/quick3d/quick3d/items/quick3dtransform.cpp +++ b/src/quick3d/quick3d/items/quick3dtransform.cpp @@ -44,7 +44,7 @@ namespace Quick { /*! \qmltype Transform - \inqmlmodule Qt3D + \inqmlmodule Qt3D.Core \since 5.5 */ Quick3DTransform::Quick3DTransform(QObject *parent) diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp index 793ca27b4..a5f1a6c47 100644 --- a/src/render/lights/qabstractlight.cpp +++ b/src/render/lights/qabstractlight.cpp @@ -43,9 +43,10 @@ namespace Qt3DRender { /*! - * \qmltype QAbstractLight + * \qmltype AbstractLight + * \inqmlmodule Qt3D.Render * \instantiates QAbstractLight - * \brief Encapsulate a QAbstractLight object in a Qt3D scene. + * \brief Encapsulate a QAbstractLight object in a Qt 3D scene. * \since 5.3 */ |