summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-11-04 12:47:51 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2015-11-23 14:15:40 +0000
commit85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch)
treed0ab865a944d837b965546248b19e1ab69e99a82 /src
parented9628c87fac466ee6106d12996373ddf56f2c73 (diff)
Doc: Fix QDoc warnings and do further cleanup
Fix the documentation issues that still remained broken after renaming the namespaces/QML modules. Do further cleanup and minor doc editing. Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/core/nodes/qnode.cpp59
-rw-r--r--src/core/qray3d.cpp40
-rw-r--r--src/core/qscenepropertychange.cpp2
-rw-r--r--src/core/services/qabstractframeadvanceservice.cpp4
-rw-r--r--src/core/services/qeventfilterservice.cpp17
-rw-r--r--src/core/services/qsysteminformationservice.cpp4
-rw-r--r--src/core/services/qtickclockservice.cpp8
-rw-r--r--src/doc/qt3d.qdocconf4
-rw-r--r--src/doc/src/qcircularbuffer.qdoc137
-rw-r--r--src/doc/src/qt3d-index.qdoc4
-rw-r--r--src/doc/src/qt3drender-framegraph.qdoc6
-rw-r--r--src/input/q3dmouseevent.cpp32
-rw-r--r--src/input/qkeyboardinput.cpp51
-rw-r--r--src/input/qmousecontroller.cpp6
-rw-r--r--src/input/qmouseinput.cpp16
-rw-r--r--src/plugins/sceneparsers/assimp/assimphelpers.cpp2
-rw-r--r--src/plugins/sceneparsers/assimp/assimpparser.cpp1
-rw-r--r--src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp23
-rw-r--r--src/render/defaults/qdiffusemapmaterial.cpp2
-rw-r--r--src/render/defaults/qdiffusespecularmapmaterial.cpp2
-rw-r--r--src/render/defaults/qgoochmaterial.cpp16
-rw-r--r--src/render/defaults/qnormaldiffusemapalphamaterial.cpp2
-rw-r--r--src/render/defaults/qnormaldiffusemapmaterial.cpp2
-rw-r--r--src/render/defaults/qnormaldiffusespecularmapmaterial.cpp2
-rw-r--r--src/render/defaults/qpervertexcolormaterial.cpp4
-rw-r--r--src/render/defaults/qphongmaterial.cpp6
-rw-r--r--src/render/defaults/qskyboxentity.cpp4
-rw-r--r--src/render/framegraph/qcameraselector.cpp6
-rw-r--r--src/render/framegraph/qframegraph.cpp17
-rw-r--r--src/render/framegraph/qframegraphnode.cpp8
-rw-r--r--src/render/framegraph/qframegraphselector.cpp2
-rw-r--r--src/render/framegraph/qlayerfilter.cpp10
-rw-r--r--src/render/framegraph/qnodraw.cpp7
-rw-r--r--src/render/framegraph/qstateset.cpp28
-rw-r--r--src/render/frontend/qlayer.cpp10
-rw-r--r--src/render/io/qabstractsceneloader.cpp2
-rw-r--r--src/render/lights/qabstractlight.cpp8
-rw-r--r--src/render/lights/qdirectionallight.cpp2
-rw-r--r--src/render/lights/qpointlight.cpp6
-rw-r--r--src/render/lights/qspotlight.cpp16
-rw-r--r--src/render/materialsystem/qannotation.cpp6
-rw-r--r--src/render/materialsystem/qgraphicsapifilter.cpp10
-rw-r--r--src/render/materialsystem/qmaterial.cpp2
-rw-r--r--src/render/materialsystem/qparametermapping.cpp12
-rw-r--r--src/render/materialsystem/qrenderpass.cpp2
-rw-r--r--src/render/materialsystem/qshaderdata.cpp13
-rw-r--r--src/render/materialsystem/qshaderprogram.cpp4
-rw-r--r--src/render/picking/qobjectpicker.cpp12
-rw-r--r--src/render/renderstates/qblendstate.cpp32
-rw-r--r--src/render/renderstates/qclipplane.cpp2
-rw-r--r--src/render/renderstates/qcolormask.cpp10
-rw-r--r--src/render/texture/qabstracttextureimage.cpp22
-rw-r--r--src/render/texture/qabstracttextureprovider.cpp5
-rw-r--r--src/render/texture/qtextureimage.cpp8
-rw-r--r--src/render/texture/qtextureproviders.cpp22
-rw-r--r--src/render/texture/qwrapmode.cpp2
56 files changed, 372 insertions, 370 deletions
diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp
index 15a7a5bf3..d93bab672 100644
--- a/src/core/nodes/qnode.cpp
+++ b/src/core/nodes/qnode.cpp
@@ -391,40 +391,39 @@ void QNodePrivate::nodePtrDeleter(QNode *q)
\inmodule Qt3DCore
\since 5.5
- \brief Qt3DCore::QNode is the base class of all Qt3D node classes used to build a
+ \brief QNode is the base class of all Qt3D node classes used to build a
Qt3D scene.
- The owernship of Qt3DCore::QNode is determined by the QObject parent/child
- relationship between nodes. By itself a Qt3DCore::QNode has no visual appearance
+ The owernship of QNode is determined by the QObject parent/child
+ relationship between nodes. By itself, a QNode has no visual appearance
and no particular meaning, it is there as a way of building a node based tree
structure.
- The parent of a Qt3DCore::QNode instance can only be another Qt3DCore::QNode
- instance.
+ The parent of a QNode instance can only be another QNode instance.
- Each Qt3DCore::QNode instance has a unique id that allows it to be recognizable
+ Each QNode instance has a unique id that allows it to be recognizable
from other instances.
- When properties are defined on a Qt3DCore::QNode subclass, their NOTIFY signal
+ When properties are defined on a QNode subclass, their NOTIFY signal
will automatically generate notifications that the Qt3D backend aspects will
receive.
- When subclassing Qt3DCore::QNode make sure to call QNode::cleanup() from your
+ When subclassing QNode, make sure to call QNode::cleanup() from your
subclass's destructor to ensure proper notification to backend aspects.
- Faiure to do so will result in crashes when one of your Qt3DCore::QNode
- subclass instance is eventually destroyed.
+ Faiure to do so will result in crashes when one of your QNode subclass
+ instance is eventually destroyed.
- \sa Qt3DCore::QEntity, Qt3DCore::QComponent
+ \sa QEntity, QComponent
*/
/*!
- Creates a new Qt3DCore::QNode instance with parent \a parent.
+ Creates a new QNode instance with parent \a parent.
- \note The backend aspects will be notified that a Qt3DCore::QNode instance is
+ \note The backend aspects will be notified that a QNode instance is
part of the scene only if it has a parent; unless this is the root node of
the Qt3D scene.
- \sa setParent(Qt3DCore::QNode *)
+ \sa setParent()
*/
QNode::QNode(QNode *parent)
: QObject(*new QNodePrivate, parent)
@@ -454,9 +453,9 @@ QNode::QNode(QNodePrivate &dd, QNode *parent)
/*!
Copies all the attributes from \a ref to the current Qt3DCore::QNode instance.
- \note When subclassing Qt3DCore::QNode you should reimplement this method and
+ \note When subclassing QNode, you should reimplement this method and
always call the copy method on the base class. This will ensure that when cloned,
- the Qt3DCore::QNode is properly initialized.
+ the QNode is properly initialized.
*/
void QNode::copy(const QNode *ref)
{
@@ -473,7 +472,7 @@ QNode::~QNode()
}
/*!
- Returns the id that uniquely identifies the Qt3DCore::QNode instance.
+ Returns the id that uniquely identifies the QNode instance.
*/
const QNodeId QNode::id() const
{
@@ -482,7 +481,7 @@ const QNodeId QNode::id() const
}
/*!
- Returns the immediate Qt3DCore::QNode parent, null if the node has no parent.
+ Returns the immediate QNode parent, or null if the node has no parent.
*/
QNode *QNode::parentNode() const
{
@@ -491,7 +490,7 @@ QNode *QNode::parentNode() const
/*!
Returns \c true if aspect notifications are blocked; otherwise returns \c false.
- Notifications are not blocked by default.
+ By default, notifications are \e not blocked.
\sa blockNotifications()
*/
@@ -502,8 +501,8 @@ bool QNode::notificationsBlocked() const
}
/*!
- If \a block is true, property change notifications sent by this object
- to aspects are blocked. If \a block is false, no such blocking will occur.
+ If \a block is \c true, property change notifications sent by this object
+ to aspects are blocked. If \a block is \c false, no such blocking will occur.
The return value is the previous value of notificationsBlocked().
@@ -521,12 +520,12 @@ bool QNode::blockNotifications(bool block)
}
/*!
- * Sets the parent node of the current Qt3DCore::QNode instance to \a parent.
- * Setting the parent will notify the backend aspects about current Qt3DCore::QNode
+ * Sets the parent node of the current QNode instance to \a parent.
+ * Setting the parent will notify the backend aspects about current QNode
* instance's parent change.
*
* \note if \a parent happens to be null, this will actually notify that the
- * current Qt3DCore::QNode instance was removed from the scene.
+ * current QNode instance was removed from the scene.
*/
void QNode::setParent(QNode *parent)
{
@@ -539,8 +538,8 @@ void QNode::setParent(QNode *parent)
}
/*!
- * Returns a list filled with the Qt3DCore::QNode children of the current
- * Qt3DCore::QNode instance.
+ * Returns a list filled with the QNode children of the current
+ * QNode instance.
*/
QNodeList QNode::childrenNodes() const
{
@@ -556,11 +555,11 @@ QNodeList QNode::childrenNodes() const
return nodeChildrenList;
}
/*!
- Set the QNode to enabled if \a enabled is true.
- By default a Qt3DCore::QNode is always enabled.
+ Set the QNode to enabled if \a isEnabled is \c true.
+ By default a QNode is always enabled.
\note the interpretation of what enabled means is aspect-dependent. Even if
- enabled is set to false, some aspects may still consider the node in
+ enabled is set to \c false, some aspects may still consider the node in
some manner. This is documented on a class by class basis.
*/
void QNode::setEnabled(bool isEnabled)
@@ -628,7 +627,7 @@ QNode *QNode::clone(QNode *node)
* aspects that the current Qt3DCore::QNode instance is about to be destroyed.
*
* \note It must be called by the destructor of every class subclassing
- * Qt3DCore::QNode that is clonable (using the QT3D_CLONEABLE macro).
+ * QNode that is clonable (using the QT3D_CLONEABLE macro).
*/
void QNode::cleanup()
{
diff --git a/src/core/qray3d.cpp b/src/core/qray3d.cpp
index 3ab27a7c4..9305baeb0 100644
--- a/src/core/qray3d.cpp
+++ b/src/core/qray3d.cpp
@@ -43,7 +43,8 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
/*!
- \class QRay3D
+ \class Qt3DCore::QRay3D
+ \inmodule Qt3DCore
\brief The QRay3D class defines a directional line in 3D space extending through an origin point.
\since 5.5
\ingroup qt3d
@@ -65,7 +66,7 @@ namespace Qt3DCore {
*/
/*!
- \fn QRay3D::QRay3D()
+ \fn Qt3DCore::QRay3D::QRay3D()
Construct a default ray with an origin() of (0, 0, 0), a
direction() of (0, 0, 1) and a distance of 1.
@@ -77,7 +78,7 @@ QRay3D::QRay3D()
}
/*!
- \fn QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance)
+ \fn Qt3DCore::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance)
Construct a ray given its defining \a origin, \a direction and \a distance.
The \a direction does not need to be normalized.
@@ -99,7 +100,7 @@ QRay3D::~QRay3D()
}
/*!
- \fn QVector3D QRay3D::origin() const
+ \fn QVector3D Qt3DCore::QRay3D::origin() const
Returns the origin of this ray. The default value is (0, 0, 0).
@@ -111,7 +112,7 @@ QVector3D QRay3D::origin() const
}
/*!
- \fn void QRay3D::setOrigin(const QVector3D &value)
+ \fn void Qt3DCore::QRay3D::setOrigin(const QVector3D &value)
Sets the origin point of this ray to \a value.
@@ -123,7 +124,7 @@ void QRay3D::setOrigin(const QVector3D &value)
}
/*!
- \fn QVector3D QRay3D::direction() const
+ \fn QVector3D Qt3DCore::QRay3D::direction() const
Returns the direction vector of this ray. The default value is (0, 0, 1).
@@ -135,7 +136,7 @@ QVector3D QRay3D::direction() const
}
/*!
- \fn void QRay3D::setDirection(const QVector3D &direction)
+ \fn void Qt3DCore::QRay3D::setDirection(const QVector3D &direction)
Sets the direction vector of this ray to \a direction.
@@ -215,7 +216,7 @@ bool QRay3D::contains(const QRay3D &ray) const
}
/*!
- \fn QVector3D QRay3D::point(float t) const
+ \fn QVector3D Qt3DCore::QRay3D::point(float t) const
Returns the point on the ray defined by moving \a t units
along the ray in the direction of the direction() vector.
@@ -279,7 +280,7 @@ float QRay3D::distance(const QVector3D &point) const
}
/*!
- \fn QRay3D &QRay3D::transform(const QMatrix4x4 &matrix)
+ \fn QRay3D &Qt3DCore::QRay3D::transform(const QMatrix4x4 &matrix)
Transforms this ray using \a matrix, replacing origin() and
direction() with the transformed versions.
@@ -288,7 +289,7 @@ float QRay3D::distance(const QVector3D &point) const
*/
/*!
- \fn QRay3D QRay3D::transformed(const QMatrix4x4 &matrix) const
+ \fn QRay3D Qt3DCore::QRay3D::transformed(const QMatrix4x4 &matrix) const
Returns a new ray that is formed by transforming origin()
and direction() using \a matrix.
@@ -297,26 +298,27 @@ float QRay3D::distance(const QVector3D &point) const
*/
/*!
- \fn bool QRay3D::operator==(const QRay3D &other)
+ \fn bool Qt3DCore::QRay3D::operator==(const QRay3D &other) const
- Returns true if this ray is the same as \a other; false otherwise.
+ Returns \c true if this ray is the same as \a other; \c false otherwise.
\sa operator!=()
*/
/*!
- \fn bool QRay3D::operator!=(const QRay3D &other)
+ \fn bool Qt3DCore::QRay3D::operator!=(const QRay3D &other) const
- Returns true if this ray is not the same as \a other; false otherwise.
+ Returns \c true if this ray is not the same as \a other; \c false otherwise.
\sa operator==()
*/
/*!
- \fn bool qFuzzyCompare(const QRay3D &ray1, const QRay3D &ray2)
- \relates QRay3D
+ \fn bool qFuzzyCompare(const Qt3DCore::QRay3D &ray1, const Qt3DCore::QRay3D &ray2)
+ \relates Qt3DCore::QRay3D
- Returns true if \a ray1 and \a ray2 are almost equal; false otherwise.
+ Returns \c true if \a ray1 and \a ray2 are almost equal; \c false
+ otherwise.
*/
#ifndef QT_NO_DEBUG_STREAM
@@ -337,7 +339,7 @@ QDebug operator<<(QDebug dbg, const QRay3D &ray)
#ifndef QT_NO_DATASTREAM
/*!
- \relates QRay3D
+ \relates Qt3DCore::QRay3D
Writes the given \a ray to the given \a stream and returns a
reference to the stream.
@@ -350,7 +352,7 @@ QDataStream &operator<<(QDataStream &stream, const QRay3D &ray)
}
/*!
- \relates QRay3D
+ \relates Qt3DCore::QRay3D
Reads a 3D ray from the given \a stream into the given \a ray
and returns a reference to the stream.
diff --git a/src/core/qscenepropertychange.cpp b/src/core/qscenepropertychange.cpp
index 08e9f73e5..768b9a5cf 100644
--- a/src/core/qscenepropertychange.cpp
+++ b/src/core/qscenepropertychange.cpp
@@ -44,7 +44,7 @@ namespace Qt3DCore {
/*!
\class Qt3DCore::QScenePropertyChange
- \inmodule Qt3dCore
+ \inmodule Qt3DCore
*/
QFrameAllocator *QScenePropertyChangePrivate::m_allocator = new QFrameAllocator(128, sizeof(QScenePropertyChange), sizeof(QScenePropertyChangePrivate) * 2);
diff --git a/src/core/services/qabstractframeadvanceservice.cpp b/src/core/services/qabstractframeadvanceservice.cpp
index c163cdf7f..a396a718a 100644
--- a/src/core/services/qabstractframeadvanceservice.cpp
+++ b/src/core/services/qabstractframeadvanceservice.cpp
@@ -49,7 +49,7 @@ namespace Qt3DCore {
/*!
\class Qt3DCore::QAbstractFrameAdvanceService
\inmodule Qt3DCore
- \brief Interface for a Qt3D frame advance service
+ \brief Interface for a Qt3D frame advance service.
This is an interface class that should be subclassed by providers of the
frame advance service. When used with the Renderer aspect, the aspect needs to
@@ -72,7 +72,7 @@ QAbstractFrameAdvanceService::QAbstractFrameAdvanceService(QAbstractFrameAdvance
}
/*!
- \fn qint64 Qt3DCore::QAbstractFrameAdvanceService::waitForNextTick()
+ \fn qint64 Qt3DCore::QAbstractFrameAdvanceService::waitForNextFrame()
Returns the current time, the call may be blocking if waiting for a tick.
*/
diff --git a/src/core/services/qeventfilterservice.cpp b/src/core/services/qeventfilterservice.cpp
index 1b0a262fb..36a39116f 100644
--- a/src/core/services/qeventfilterservice.cpp
+++ b/src/core/services/qeventfilterservice.cpp
@@ -57,9 +57,6 @@ bool operator <(const FilterPriorityPair &a, const FilterPriorityPair &b)
return a.priority < b.priority;
}
-/*!
- \internal
- */
class InternalEventListener : public QObject
{
Q_OBJECT
@@ -111,9 +108,6 @@ private:
} // anonymous
-/*!
- \internal
- */
class QEventFilterServicePrivate : public QAbstractServiceProviderPrivate
{
public:
@@ -125,13 +119,16 @@ public:
};
-
/*!
\class Qt3DCore::QEventFilterService
+ \inmodule Qt3DCore
+
+ \brief Allows to register event filters with a priority.
- \brief Allows to register event filters with a priority. Events are dispatched
- to the event filter with the highest priority first, and then propagates to
- lower priority event filters if the event wasn't accepted.
+ The QEventFilterService class allows registering prioritized event filters.
+ Events are dispatched to the event filter with the highest priority first,
+ and then propagates to lower priority event filters if the event wasn't
+ accepted.
*/
QEventFilterService::QEventFilterService()
diff --git a/src/core/services/qsysteminformationservice.cpp b/src/core/services/qsysteminformationservice.cpp
index c5a7269d1..73148932b 100644
--- a/src/core/services/qsysteminformationservice.cpp
+++ b/src/core/services/qsysteminformationservice.cpp
@@ -79,14 +79,14 @@ QSystemInformationService::QSystemInformationService(QSystemInformationServicePr
}
/*!
- \fn QStringList Qt3DCore::QSystemInformationService::aspectNames()
+ \fn QStringList Qt3DCore::QSystemInformationService::aspectNames() const
Subclasses should override this function and return a string list containing the
names of all registered aspects.
*/
/*!
- \fn int threadPoolThreadCount() const
+ \fn int Qt3DCore::QSystemInformationService::threadPoolThreadCount() const
Subclasses should override this function and return the number of threads in the
Qt3D task manager's threadpool.
diff --git a/src/core/services/qtickclockservice.cpp b/src/core/services/qtickclockservice.cpp
index aebea9745..f13dbfdc5 100644
--- a/src/core/services/qtickclockservice.cpp
+++ b/src/core/services/qtickclockservice.cpp
@@ -41,10 +41,6 @@
QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
- \class Qt3DCore::QTickClockServicePrivate
- \internal
-*/
class QTickClockServicePrivate : public QAbstractFrameAdvanceServicePrivate
{
@@ -62,9 +58,9 @@ public:
/*!
\class Qt3DCore::QTickClockService
\inmodule Qt3DCore
- \brief Default Qt3DCore::QAbstractFrameAdvanceService implementation.
+ \brief Default QAbstractFrameAdvanceService implementation.
- This default Qt3DCore::QAbstractFrameAdvanceService implementation has a frequency of 60 Hz.
+ This default QAbstractFrameAdvanceService implementation has a frequency of 60 Hz.
*/
QTickClockService::QTickClockService()
: QAbstractFrameAdvanceService(*new QTickClockServicePrivate())
diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index 1a63a8bd5..cb0d6c3a6 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -74,8 +74,8 @@ Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \
QT3DCORESHARED_EXPORT \
QT3DLOGIC_PRIVATE_EXPORT \
QT3DLOGICSHARED_EXPORT \
- QT3DRENDERERSHARED_EXPORT \
- QT3DRENDERERSHARED_PRIVATE_EXPORT
+ QT3DRENDERSHARED_EXPORT \
+ QT3DRENDERSHARED_PRIVATE_EXPORT
Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
diff --git a/src/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc
index d34e72e53..37fbda633 100644
--- a/src/doc/src/qcircularbuffer.qdoc
+++ b/src/doc/src/qcircularbuffer.qdoc
@@ -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 Qt3DCore::QCircularBuffer::array_range object describing the array of items stored
+ returns an \l 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
@@ -170,7 +170,7 @@
of the circular buffer in the constructor or immediately after construction,
and then simply keep appending to the buffer. If you wish to reclaim any
unused memory from the circular buffer, then call squeeze(). This is
- equivalent to calling setCapacity( size() ).
+ equivalent to calling \l {setCapacity()}{setCapacity}( size() ).
Note that using non-const operators and functions can cause
QCircularBuffer to do a deep copy of the data. This is due to
@@ -184,16 +184,15 @@
support \c operator==(). These requirements are documented on a
per-function basis.
- 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 provides \l{STL-Style Iterators} (\l {const_iterator}
+ and \l {iterator}). In practice, these are rarely used,
+ because you can use indexes into the buffer.
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 Qt3DCore::QCircularBuffer::iterator, Qt3DCore::QCircularBuffer::const_iterator,
- QVector, QList, QLinkedList
+ \sa iterator, const_iterator, QVector, QList, QLinkedList
*/
/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer()
@@ -462,7 +461,7 @@
/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::data()
- Returns a Qt3DCore::QCircularBuffer::array_range describing the internal array of data. If
+ Returns an \l 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.
@@ -484,7 +483,7 @@
/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constData() const
- Returns a Qt3DCore::QCircularBuffer::const_array_range describing the internal array of
+ Returns a \l const_array_range describing the internal array of
data.
If the circular buffer is non-linearized then the pointer and array size
@@ -499,13 +498,13 @@
/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataOne()
- Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of
+ Returns an \l 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 Qt3DCore::QCircularBuffer::array_range for the remainder
- of the data, use the dataTwo() function.
+ in the buffer. To obtain an \l 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
will both be 0.
@@ -517,19 +516,19 @@
\overload
- Unlike data() this function always returns a valid Qt3DCore::QCircularBuffer::const_array_range
+ Unlike data(), this function always returns a valid \l const_array_range
(unless the circular buffer is empty).
*/
/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataOne() const
- Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of
+ Returns a \l 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 Qt3DCore::QCircularBuffer::const_array_range for the remainder
- of the data, use the constDataTwo() function.
+ in the buffer. To obtain a \l 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
will both be 0.
@@ -539,7 +538,7 @@
/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataTwo()
- Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of
+ Returns an \l 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.
@@ -554,7 +553,7 @@
/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataTwo() const
- Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of
+ Returns a \l 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.
@@ -564,8 +563,8 @@
/*! \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.
+ Returns \c true if this circular buffer is not empty and its last
+ item is equal to \a value; otherwise returns \c false.
\sa isEmpty(), last(), startsWith()
*/
@@ -655,9 +654,9 @@
Using this function is equivalent to calling insert(i, 1, value). See the
discussion there for more information.
- Items at indexes i and higher are shifted along by one. If the circular
+ Items at indexes \a i and higher are shifted along by one. If the circular
buffer is full then the earliest item will be overwritten. Note that this
- has the non-obvious behavior that calling insert(0,value) on a circular
+ has the non-obvious behavior that calling \c {insert(0, value)} on a circular
buffer that is already full will effectively do nothing since the newly
prepended item will immediately be overwritten by the highest item as it
is shifted along one position.
@@ -683,7 +682,7 @@
is size(), the value is appended to the circular buffer. The capacity
of the circular buffer is not changed.
- Items at indexes i and higher are shifted along by one. If the circular
+ Items at indexes \a i and higher are shifted along by one. If the circular
buffer has freeSize() < \a count, then the earliest items will be overwritten.
The actual number of items that get inserted may not always be equal to
@@ -745,7 +744,8 @@
/*! \fn bool Qt3DCore::QCircularBuffer::isLinearised() const
- Returns true if the circular buffer is linearized; otherwise returns false.
+ Returns \c true if the circular buffer is linearized; otherwise returns
+ \c false.
A circular buffer is said to be linearized if the position of the first
item in the internal array occurs before the position of the last item. A
@@ -800,15 +800,15 @@
If you need to directly access the items stored in a circular buffer,
(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
- Qt3DCore::QCircularBuffer::array_range describing the array.
+ function will linearize it for you before returning an \l 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
used to represent a non-linearized circular buffer. After running the
above sample code, calling the dataOne() function would return an
- array_range object describing the values 2-6, and the dataTwo() function
- would return an array_range object describing the value 7. Sometimes,
+ \l array_range object describing the values 2-6, and the dataTwo() function
+ would return an \l array_range object describing the value 7. Sometimes,
accessing the items via the two arrays described by dataOne() and dataTwo(),
can be quicker than calling data() and having the circular buffer
linearized. The dataOne() and dataTwo() functions do not trigger a
@@ -949,8 +949,8 @@
/*! \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.
+ Returns \c true if the circular buffer is not empty and its first
+ item is equal to \a value; otherwise returns \c false.
\sa isEmpty(), first(), endsWith()
*/
@@ -995,8 +995,8 @@
/*! \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.
+ Returns \c true if the circular buffer \a lhs is equal to \a rhs; otherwise
+ returns \c false.
Two circular buffers are considered equal if they contain the same values
in the same order and have the same capacity.
@@ -1009,8 +1009,8 @@
/*! \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.
+ Returns \c true if the circular buffer \a lhs is not equal to \a rhs; otherwise
+ returns \c false.
Two circular buffers are considered equal if they contain the same values
in the same order and have the same capacity.
@@ -1078,11 +1078,12 @@
*/
/*! \fn Qt3DCore::QCircularBuffer<T> Qt3DCore::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs)
+ \relates Qt3DCore::QCircularBuffer
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 Qt3DCore::QCircularBuffer::operator+=()
+ \sa {QCircularBuffer::}{operator+=()}
*/
/*! \fn void Qt3DCore::swap(QCircularBuffer<T> &lhs, QCircularBuffer<T> &rhs)
@@ -1092,33 +1093,33 @@
/*! \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
+ Returns \c 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 Qt3DCore::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
- Returns true if \a rhs is lexographically less than \a lhs.
+ Returns \c true if \a rhs is lexographically less than \a lhs.
*/
/*! \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.
+ Returns \c true if \a lhs is lexographically less than or equal to \a 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.
+ Returns \c true if \a lhs is lexographically less than or equal to \a rhs.
*/
/*! \typedef Qt3DCore::QCircularBuffer::Iterator
- Qt-style synonym for Qt3DCore::QCircularBuffer::iterator.
+ Qt-style synonym for \l iterator.
*/
/*! \typedef Qt3DCore::QCircularBuffer::ConstIterator
- Qt-style synonym for Qt3DCore::QCircularBuffer::const_iterator.
+ Qt-style synonym for \l const_iterator.
*/
/*! \typedef Qt3DCore::QCircularBuffer::const_pointer
@@ -1174,12 +1175,12 @@
/*! \typedef Qt3DCore::QCircularBuffer::ArrayRange
- Qt-style synonym for Qt3DCore::QCircularBuffer::array_range.
+ Qt-style synonym for \l array_range.
*/
/*! \typedef Qt3DCore::QCircularBuffer::ConstArrayRange
- Qt-style synonym for Qt3DCore::QCircularBuffer::const_array_range.
+ Qt-style synonym for \l const_array_range.
*/
@@ -1190,8 +1191,7 @@
QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style
Iterators}.
- \sa Qt3DCore::QCircularBuffer::begin(), Qt3DCore::QCircularBuffer::end(),
- Qt3DCore::QCircularBuffer::const_iterator
+ \sa begin(), end(), const_iterator
*/
/*! \typedef Qt3DCore::QCircularBuffer::iterator::iterator_category
@@ -1228,7 +1228,7 @@
on an uninitialized iterator. Use operator=() to assign a value
to it before using it.
- \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end()
+ \sa begin(), end()
*/
/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index)
@@ -1267,8 +1267,8 @@
/*!
\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.
+ Returns \c true if \a other points to the same item as this
+ iterator; otherwise returns \c false.
\sa operator!=()
*/
@@ -1276,8 +1276,8 @@
/*!
\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.
+ Returns \c true if \a other points to a different item than this
+ iterator; otherwise returns \c false.
\sa operator==()
*/
@@ -1285,28 +1285,28 @@
/*!
\fn bool Qt3DCore::QCircularBuffer::iterator::operator<(const iterator& other) const
- Returns true if the item pointed to by this iterator occurs before
+ Returns \c true if the item pointed to by this iterator occurs before
the item pointed to by the \a other iterator.
*/
/*!
\fn bool Qt3DCore::QCircularBuffer::iterator::operator<=(const iterator& other) const
- Returns true if the item pointed to by this iterator occurs before
+ Returns \c 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 Qt3DCore::QCircularBuffer::iterator::operator>(const iterator& other) const
- Returns true if the item pointed to by this iterator occurs after
+ Returns \c true if the item pointed to by this iterator occurs after
the item pointed to by the \a other iterator.
*/
/*!
\fn bool Qt3DCore::QCircularBuffer::iterator::operator>=(const iterator& other) const
- Returns true if the item pointed to by this iterator occurs after
+ Returns \c 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.
*/
@@ -1316,7 +1316,7 @@
next item in the circular buffer and returns an iterator to the new current
item.
- Calling this function on Qt3DCore::QCircularBuffer::end() leads to undefined results.
+ Calling this function on end() leads to undefined results.
\sa operator--()
*/
@@ -1335,7 +1335,7 @@
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 Qt3DCore::QCircularBuffer::begin() leads to undefined results.
+ Calling this function on begin() leads to undefined results.
\sa operator++()
*/
@@ -1394,8 +1394,7 @@
QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style
Iterators}.
- \sa Qt3DCore::QCircularBuffer::constBegin(), Qt3DCore::QCircularBuffer::constEnd(),
- Qt3DCore::QCircularBuffer::iterator
+ \sa constBegin(), constEnd(), iterator
*/
/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::iterator_category
@@ -1432,7 +1431,7 @@
on an uninitialized iterator. Use operator=() to assign a value
to it before using it.
- \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end()
+ \sa begin(), end()
*/
/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator(const iterator &other)
@@ -1468,8 +1467,8 @@
/*!
\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.
+ Returns \c true if \a other points to the same item as this
+ iterator; otherwise returns \c false.
\sa operator!=()
*/
@@ -1477,8 +1476,8 @@
/*!
\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.
+ Returns \c true if \a other points to a different item than this
+ iterator; otherwise returns \c false.
\sa operator==()
*/
@@ -1486,28 +1485,28 @@
/*!
\fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const
- Returns true if the item pointed to by this iterator occurs before
+ Returns \c true if the item pointed to by this iterator occurs before
the item pointed to by the \a other iterator.
*/
/*!
\fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const
- Returns true if the item pointed to by this iterator occurs before,
+ Returns \c 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 Qt3DCore::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const
- Returns true if the item pointed to by this iterator occurs after
+ Returns \c true if the item pointed to by this iterator occurs after
the item pointed to by the \a other iterator.
*/
/*!
\fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const
- Returns true if the item pointed to by this iterator occurs after,
+ Returns \c 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.
*/
@@ -1517,7 +1516,7 @@
next item in the circular buffer and returns an iterator to the new current
item.
- Calling this function on Qt3DCore::QCircularBuffer::constEnd() leads to undefined results.
+ Calling this function on constEnd() leads to undefined results.
\sa operator--()
*/
@@ -1536,7 +1535,7 @@
The prefix -- operator (\c{--it}) makes the preceding item the
current and returns an iterator to the new current item.
- Calling this function on Qt3DCore::QCircularBuffer::constBegin() leads to undefined results.
+ Calling this function on constBegin() leads to undefined results.
\sa operator++()
*/
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index 23c99f8b0..99a549b9b 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -47,9 +47,7 @@
\annotatedlist qt3d-modules
- Classes, types and functions are declared under the \l[CPP]{Qt 3D} namespace.
-
- For Qt Quick applications, Qt 3D provides the following QML modules:
+ For Qt Quick applications, Qt3D provides the following QML modules:
\annotatedlist qt3d-qmlmodules
diff --git a/src/doc/src/qt3drender-framegraph.qdoc b/src/doc/src/qt3drender-framegraph.qdoc
index 0f5fd67af..6d7c4207b 100644
--- a/src/doc/src/qt3drender-framegraph.qdoc
+++ b/src/doc/src/qt3drender-framegraph.qdoc
@@ -60,7 +60,7 @@
all change which states a renderer needs to set over the course of a frame
and when those state changes need to occur.
- As a comparison, the \l {qtquick-visualcanvas-scenegraph}{Qt Quick 2
+ As a comparison, the \l {Qt Quick Scene Graph}{Qt Quick 2
scenegraph renderer} responsible for drawing Qt Quick 2 scenes is
hard-wired in C++ to do things like batching of primitives and rendering
opaque items followed by rendering of transparent items. In the case of Qt
@@ -102,7 +102,9 @@
best. For the sake of readability and conciseness, the QML API was chosen
for this article.
- // TODO: Add list of framegraph node types
+ \omit
+ TODO: Add list of framegraph node types
+ \endomit
The beauty of the framegraph is that combining these simple node types, it
is possible to configure the renderer to suit your specific needs without
diff --git a/src/input/q3dmouseevent.cpp b/src/input/q3dmouseevent.cpp
index d880c7585..8446a0a5a 100644
--- a/src/input/q3dmouseevent.cpp
+++ b/src/input/q3dmouseevent.cpp
@@ -59,30 +59,30 @@ namespace Qt3DInput {
*
* \since 5.5
*
- * \sa Qt3DCore::Q3DKeyEvent, Qt3DCore::Q3DWheelEvent, Qt3DCore::QMouseInput
+ * \sa Q3DKeyEvent, Q3DWheelEvent, QMouseInput
*
*/
/*!
- * \fn int Qt3DCore::Q3DMouseEvent::x() const
+ * \fn int Qt3DInput::Q3DMouseEvent::x() const
*
* Returns the x position of the mouse event.
*/
/*!
- * \fn int Qt3DCore::Q3DMouseEvent::y() const
+ * \fn int Qt3DInput::Q3DMouseEvent::y() const
*
* Returns the y position of the mouse event.
*/
/*!
- * \fn bool Qt3DCore::Q3DMouseEvent::isAccepted() const
+ * \fn bool Qt3DInput::Q3DMouseEvent::isAccepted() const
*
* Returns whether the event was accepted.
*/
/*!
- * \fn void Qt3DCore::Q3DMouseEvent::setAccepted(bool accepted)
+ * \fn void Qt3DInput::Q3DMouseEvent::setAccepted(bool accepted)
*
* Sets the event as accepted if \a accepted is true.
*
@@ -91,13 +91,13 @@ namespace Qt3DInput {
*/
/*!
- * \fn QEvent::Type Qt3DCore::Q3DMouseEvent::type() const
+ * \fn QEvent::Type Qt3DInput::Q3DMouseEvent::type() const
*
* Returns the QEvent::Type of the event.
*/
/*!
- * Constructs a new Qt3DCore::Q3DMouseEvent instance for the QMouseEvent \a e.
+ * Constructs a new Q3DMouseEvent instance for the QMouseEvent \a e.
*/
Q3DMouseEvent::Q3DMouseEvent(const QMouseEvent &e)
: QObject()
@@ -163,30 +163,30 @@ Q3DMouseEvent::Modifiers Q3DMouseEvent::modifier() const
* \class Qt3DInput::Q3DWheelEvent
* \inmodule Qt3DInput
*
- * \brief The Qt3DCore::Q3DWheelEvent contains parameters that describe a mouse wheel event.
+ * \brief The Q3DWheelEvent class contains parameters that describe a mouse wheel event.
*
* Mouse wheel events occur when the mouse is rotated.
*
* \since 5.5
*
- * \sa Qt3DCore::Q3DKeyEvent, Qt3DCore::Q3DMouseEvent, Qt3DCore::QMouseInput
+ * \sa Q3DKeyEvent, Q3DMouseEvent, QMouseInput
*
*/
/*!
- * \fn int Qt3DCore::Q3DWheelEvent::x() const
+ * \fn int Qt3DInput::Q3DWheelEvent::x() const
*
* Returns the x position of the mouse event.
*/
/*!
- * \fn int Qt3DCore::Q3DWheelEvent::y() const
+ * \fn int Qt3DInput::Q3DWheelEvent::y() const
*
* Returns the x position of the mouse event.
*/
/*!
- * \fn QPoint Qt3DCore::Q3DWheelEvent::angleDelta() const
+ * \fn QPoint Qt3DInput::Q3DWheelEvent::angleDelta() const
*
* Returns the distance that the wheel is rotated, in eighths of a degree. A
* positive value indicates that the wheel was rotated forward (away from the
@@ -195,13 +195,13 @@ Q3DMouseEvent::Modifiers Q3DMouseEvent::modifier() const
*/
/*!
- * \fn bool Qt3DCore::Q3DWheelEvent::isAccepted() const
+ * \fn bool Qt3DInput::Q3DWheelEvent::isAccepted() const
*
* Returns whether the event was accepted.
*/
/*!
- * \fn void Qt3DCore::Q3DWheelEvent::setAccepted(bool accepted)
+ * \fn void Qt3DInput::Q3DWheelEvent::setAccepted(bool accepted)
*
* Sets the event as accepted if \a accepted is true.
*
@@ -210,13 +210,13 @@ Q3DMouseEvent::Modifiers Q3DMouseEvent::modifier() const
*/
/*!
- * \fn QEvent::Type Qt3DCore::Q3DWheelEvent::type() const
+ * \fn QEvent::Type Qt3DInput::Q3DWheelEvent::type() const
*
* Returns the QEvent::Type of the event.
*/
/*!
- * Constructs a new Qt3DCore::Q3DWheelEvent instance from the QWheelEvent \a e.
+ * Constructs a new Q3DWheelEvent instance from the QWheelEvent \a e.
*/
Q3DWheelEvent::Q3DWheelEvent(const QWheelEvent &e)
: QObject()
diff --git a/src/input/qkeyboardinput.cpp b/src/input/qkeyboardinput.cpp
index bf9cac074..a36f306ea 100644
--- a/src/input/qkeyboardinput.cpp
+++ b/src/input/qkeyboardinput.cpp
@@ -211,7 +211,7 @@ void QKeyboardInput::setController(QKeyboardController *controller)
}
/*!
- \returns the current keyboard controller.
+ Returns the current keyboard controller.
*/
QKeyboardController *QKeyboardInput::controller() const
{
@@ -224,7 +224,7 @@ QKeyboardController *QKeyboardInput::controller() const
*/
/*!
- \returns the current focus.
+ Returns the current focus.
*/
bool QKeyboardInput::focus() const
{
@@ -233,7 +233,8 @@ bool QKeyboardInput::focus() const
}
/*!
- Sets the focus to \a focus. If focus is not currently set to true, this component will receive keyboard focus.
+ Sets the focus to \a focus. If focus is not currently set to \c true,
+ this component will receive keyboard focus.
*/
void QKeyboardInput::setFocus(bool focus)
{
@@ -321,91 +322,91 @@ void QKeyboardInput::setFocus(bool focus)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::escapePressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::escapePressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::returnPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::returnPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::enterPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::enterPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::deletePressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::deletePressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::spacePressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::spacePressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::backPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::backPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::cancelPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::cancelPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::selectPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::selectPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::yesPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::yesPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::noPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::noPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::context1Pressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::context1Pressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::context2Pressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::context2Pressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::context3Pressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::context3Pressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::context4Pressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::context4Pressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::callPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::callPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::hangupPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::hangupPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::flipPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::flipPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::menuPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::menuPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::volumeUpPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::volumeUpPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::volumeDownPressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::volumeDownPressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::pressed(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::pressed(KeyEvent event)
*/
/*!
- qmlsignal Qt3D.Input::KeyboardInput::released(KeyEvent event)
+ \qmlsignal Qt3D.Input::KeyboardInput::released(KeyEvent event)
*/
} // namespace Qt3DInput
diff --git a/src/input/qmousecontroller.cpp b/src/input/qmousecontroller.cpp
index 49acc17aa..461296056 100644
--- a/src/input/qmousecontroller.cpp
+++ b/src/input/qmousecontroller.cpp
@@ -53,11 +53,11 @@ QMouseControllerPrivate::QMouseControllerPrivate()
* \class Qt3DInput::QMouseController
* \inmodule Qt3DInput
*
- * \brief Qt3DCore::QMouseController is in charge of dispatching mouse events to
- * attached Qt3DCore::QMouseInput objects.
+ * \brief QMouseController is in charge of dispatching mouse events to
+ * attached QMouseInput objects.
*
* \since 5.5
- * \sa Qt3DCore::QMouseInput
+ * \sa QMouseInput
*/
QMouseController::QMouseController(QNode *parent)
: QNode(*new QMouseControllerPrivate, parent)
diff --git a/src/input/qmouseinput.cpp b/src/input/qmouseinput.cpp
index dc0bfe567..3fbafda47 100644
--- a/src/input/qmouseinput.cpp
+++ b/src/input/qmouseinput.cpp
@@ -59,18 +59,18 @@ QMouseInputPrivate::QMouseInputPrivate()
* \inmodule Qt3DInput
*
* \brief Provides a mean of being notified about mouse events when attached to
- * a Qt3DCore::QMouseController instance.
+ * a QMouseController instance.
*
* \since 5.5
*
- * \note Qt3DCore::QMouseInput components shouldn't be shared, not respecting that
+ * \note QMouseInput components shouldn't be shared, not respecting that
* condition will most likely result in undefined behaviors.
*
- * \sa Qt3DCore::QMouseController
+ * \sa QMouseController
*/
/*!
- * Constructs a new Qt3DCore::QMouseInput instance with parent \a parent.
+ * Constructs a new QMouseInput instance with parent \a parent.
*/
QMouseInput::QMouseInput(QNode *parent)
: QComponent(*new QMouseInputPrivate, parent)
@@ -94,7 +94,7 @@ QMouseInput::~QMouseInput()
}
/*!
- * Sets the mouse controller of the Qt3DCore::QMouseInput instance to \a controller.
+ * Sets the mouse controller of the QMouseInput instance to \a controller.
*/
void QMouseInput::setController(QMouseController *controller)
{
@@ -115,11 +115,11 @@ QMouseController *QMouseInput::controller() const
}
/*!
- * Returns true if the QMouseInput currently contains the mouse.
+ * Returns \c true if the QMouseInput currently contains the mouse.
*
- * \note: In this context, contains mean that the ray originating from the
+ * \note In this context, contains mean that the ray originating from the
* mouse is intersecting with the Qt3DCore::QEntity that aggregates the current
- * Qt3DCore::QMouseInput instance component.
+ * QMouseInput instance component.
*/
bool QMouseInput::containsMouse() const
{
diff --git a/src/plugins/sceneparsers/assimp/assimphelpers.cpp b/src/plugins/sceneparsers/assimp/assimphelpers.cpp
index 72dd3b5ce..474885bd3 100644
--- a/src/plugins/sceneparsers/assimp/assimphelpers.cpp
+++ b/src/plugins/sceneparsers/assimp/assimphelpers.cpp
@@ -145,7 +145,7 @@ void AssimpIOStream::Flush()
}
/*!
- * \class AssimpIOSystem
+ * \class Qt3DRender::AssimpHelper::AssimpIOSystem
*
* \internal
*
diff --git a/src/plugins/sceneparsers/assimp/assimpparser.cpp b/src/plugins/sceneparsers/assimp/assimpparser.cpp
index 0d40b06c2..0768d408e 100644
--- a/src/plugins/sceneparsers/assimp/assimpparser.cpp
+++ b/src/plugins/sceneparsers/assimp/assimpparser.cpp
@@ -65,6 +65,7 @@ namespace Qt3DRender {
/*!
\class Qt3DRender::AssimpParser
+ \inmodule Qt3DRender
\since 5.5
\brief Provides a generic way of loading various 3D assets
diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
index f4021b999..50f39130a 100644
--- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
+++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
@@ -222,7 +222,6 @@ void Quick3DNodeInstantiatorPrivate::makeModel()
/*!
\qmltype NodeInstantiator
- \instantiates Quick3DNodeInstantiator
\inqmlmodule Qt3D.Core
\brief Dynamically creates nodes.
\since 5.5
@@ -249,7 +248,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
}
/*!
- \qmlsignal Qt3DCore::NodeInstantiator::objectAdded(int index, QtObject node)
+ \qmlsignal Qt3D.Core::NodeInstantiator::objectAdded(int index, QtObject node)
This signal is emitted when a node is added to the NodeInstantiator. The \a index
parameter holds the index which the node has been given, and the \a node
@@ -259,11 +258,11 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
*/
/*!
- \qmlsignal Qt3DCore::NodeInstantiator::objectRemoved(int index, QtObject object)
+ \qmlsignal Qt3D.Core::NodeInstantiator::objectRemoved(int index, QtObject object)
This signal is emitted when an object is removed from the Instantiator. The \a index
parameter holds the index which the object had been given, and the \a object
- parameter holds the \l QtObject that has been removed.
+ parameter holds the \l [QML] {QtQml::}{QtObject} that has been removed.
Do not keep a reference to \a object if it was created by this Instantiator, as
in these cases it will be deleted shortly after the signal is handled.
@@ -271,7 +270,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator()
The corresponding handler is \c onObjectRemoved.
*/
/*!
- \qmlproperty bool Qt3DCore::NodeInstantiator::active
+ \qmlproperty bool Qt3D.Core::NodeInstantiator::active
When active is \c true, and the delegate component is ready, the Instantiator will
create objects according to the model. When active is \c false, no objects
@@ -296,7 +295,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal)
}
/*!
- \qmlproperty bool Qt3DCore::NodeInstantiator::asynchronous
+ \qmlproperty bool Qt3D.Core::NodeInstantiator::asynchronous
When asynchronous is true the Instantiator will attempt to create objects
asynchronously. This means that objects may not be available immediately,
@@ -304,7 +303,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal)
You can use the objectAdded signal to respond to items being created.
- Default is false.
+ Default is \c false.
*/
bool Quick3DNodeInstantiator::isAsync() const
{
@@ -323,7 +322,7 @@ void Quick3DNodeInstantiator::setAsync(bool newVal)
/*!
- \qmlproperty int Qt3DCore::NodeInstantiator::count
+ \qmlproperty int Qt3D.Core::NodeInstantiator::count
\readonly
The number of objects the Instantiator is currently managing.
@@ -336,7 +335,7 @@ int Quick3DNodeInstantiator::count() const
}
/*!
- \qmlproperty QtQml::Component Qt3DCore::NodeInstantiator::delegate
+ \qmlproperty QtQml::Component Qt3D.Core::NodeInstantiator::delegate
\default
The component used to create all objects.
@@ -373,7 +372,7 @@ void Quick3DNodeInstantiator::setDelegate(QQmlComponent *c)
}
/*!
- \qmlproperty variant Qt3DCore::NodeInstantiator::model
+ \qmlproperty variant Qt3D.Core::NodeInstantiator::model
This property can be set to any of the supported \l {qml-data-models}{data models}:
@@ -448,7 +447,7 @@ void Quick3DNodeInstantiator::setModel(const QVariant &v)
}
/*!
- \qmlproperty QtQml::QtObject Qt3DCore::NodeInstantiator::object
+ \qmlproperty QtQml::QtObject Qt3D.Core::NodeInstantiator::object
\readonly
This is a reference to the first created object, intended as a convenience
@@ -463,7 +462,7 @@ QObject *Quick3DNodeInstantiator::object() const
}
/*!
- \qmlmethod QtQml::QtObject Qt3DCore::NodeInstantiator::objectAt(int index)
+ \qmlmethod QtQml::QtObject Qt3D.Core::NodeInstantiator::objectAt(int index)
Returns a reference to the object with the given \a index.
*/
diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp
index 6906177e0..d738e1592 100644
--- a/src/render/defaults/qdiffusemapmaterial.cpp
+++ b/src/render/defaults/qdiffusemapmaterial.cpp
@@ -132,7 +132,7 @@ void QDiffuseMapMaterialPrivate::init()
\class Qt3DRender::QDiffuseMapMaterial
\brief The QDiffuseMapMaterial provides a default implementation of the phong lighting effect where the diffuse light component
is read from a texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qdiffusespecularmapmaterial.cpp b/src/render/defaults/qdiffusespecularmapmaterial.cpp
index c03664681..746739ed3 100644
--- a/src/render/defaults/qdiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp
@@ -140,7 +140,7 @@ void QDiffuseSpecularMapMaterialPrivate::init()
\class Qt3DRender::QDiffuseSpecularMapMaterial
\brief The QDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components
are read from texture maps.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qgoochmaterial.cpp b/src/render/defaults/qgoochmaterial.cpp
index 30e196fc7..d35bbb68d 100644
--- a/src/render/defaults/qgoochmaterial.cpp
+++ b/src/render/defaults/qgoochmaterial.cpp
@@ -132,7 +132,7 @@ void QGoochMaterialPrivate::init()
\class Qt3DRender::QGoochMaterial
\brief The QGoochMaterial provides a material that implements the Gooch
shading model, popular in CAD and CAM applications.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The Gooch lighting model uses both color and brightness to help show the
@@ -174,7 +174,7 @@ QGoochMaterial::QGoochMaterial(QGoochMaterialPrivate &dd, QNode *parent)
}
/*!
- \property Qt3DCore::QGoochMaterial::diffuse
+ \property Qt3DRender::QGoochMaterial::diffuse
Holds the current diffuse color.
*/
@@ -185,7 +185,7 @@ QColor QGoochMaterial::diffuse() const
}
/*!
- \property Qt3DCore::QGoochMaterial::specular
+ \property Qt3DRender::QGoochMaterial::specular
Holds the current specular color.
*/
@@ -196,7 +196,7 @@ QColor QGoochMaterial::specular() const
}
/*!
- \property Qt3DCore::QGoochMaterial::cool
+ \property Qt3DRender::QGoochMaterial::cool
Holds the current cool color.
*/
@@ -207,7 +207,7 @@ QColor QGoochMaterial::cool() const
}
/*!
- \property Qt3DCore::QGoochMaterial::warm
+ \property Qt3DRender::QGoochMaterial::warm
Holds the current warm color.
*/
@@ -218,7 +218,7 @@ QColor QGoochMaterial::warm() const
}
/*!
- \property Qt3DCore::QGoochMaterial::alpha
+ \property Qt3DRender::QGoochMaterial::alpha
Holds the current alpha value. The start point of the color ramp
used by the Gooch shader is calculated as {c = cool + alpha * diffuse}.
@@ -230,7 +230,7 @@ float QGoochMaterial::alpha() const
}
/*!
- \property Qt3DCore::QGoochMaterial::beta
+ \property Qt3DRender::QGoochMaterial::beta
Holds the current beta value. The start point of the color ramp
used by the Gooch shader is calculated as {c = warm + beta * diffuse}.
@@ -242,7 +242,7 @@ float QGoochMaterial::beta() const
}
/*!
- \property Qt3DCore::QGoochMaterial::shininess
+ \property Qt3DRender::QGoochMaterial::shininess
Holds the current shininess value. Higher values of shininess result in
a smaller and brighter highlight.
diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
index c67dc3bfe..602a111d7 100644
--- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
@@ -129,7 +129,7 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init()
\brief The QNormalDiffuseMapAlphaMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component
is read from a texture map and the normals of the mesh being rendered from a normal texture map. In addition, it defines an alpha to coverage and
a depth test to be performed in the rendering pass.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp
index b31337053..259ac54d8 100644
--- a/src/render/defaults/qnormaldiffusemapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp
@@ -141,7 +141,7 @@ void QNormalDiffuseMapMaterialPrivate::init()
\class Qt3DRender::QNormalDiffuseMapMaterial
\brief The QNormalDiffuseMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component
is read from a texture map and the normals of the mesh being rendered from a normal texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
index 420f22a7d..8f263153d 100644
--- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
@@ -147,7 +147,7 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init()
\class Qt3DRender::QNormalDiffuseSpecularMapMaterial
\brief The QNormalDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components
are read from texture maps and the normals of the mesh being rendered from a normal texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qpervertexcolormaterial.cpp b/src/render/defaults/qpervertexcolormaterial.cpp
index 27f7de224..5ea8f9fbf 100644
--- a/src/render/defaults/qpervertexcolormaterial.cpp
+++ b/src/render/defaults/qpervertexcolormaterial.cpp
@@ -74,7 +74,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate()
/*!
\class Qt3DRender::QPerVertexColorMaterial
\brief The QPerVertexColorMaterial class provides a default implementation for rendering the color properties set for each vertex.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
This lighting effect is based on the combination of 2 lighting components ambient and diffuse. Ambient is set by the vertex color.
@@ -90,7 +90,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate()
*/
/*!
- \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(QNode *parent)
+ \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(Qt3DCore::QNode *parent)
Constructs a new QPerVertexColorMaterial instance with parent object \a parent.
*/
diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp
index 2a4663f27..4c08d3713 100644
--- a/src/render/defaults/qphongmaterial.cpp
+++ b/src/render/defaults/qphongmaterial.cpp
@@ -78,7 +78,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate()
/*!
\class Qt3DRender::QPhongMaterial
\brief The QPhongMaterial class provides a default implementation of the phong lighting effect.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
@@ -96,7 +96,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate()
*/
/*!
- \fn Qt3DRender::QPhongMaterial::QPhongMaterial(QNode *parent)
+ \fn Qt3DRender::QPhongMaterial::QPhongMaterial(Qt3DCore::QNode *parent)
Constructs a new QPhongMaterial instance with parent object \a parent.
*/
@@ -143,7 +143,7 @@ QColor QPhongMaterial::diffuse() const
}
/*!
- \property QColor Qt3DRender::QPhongMaterial::specular
+ \property Qt3DRender::QPhongMaterial::specular
Holds the specular color.
*/
diff --git a/src/render/defaults/qskyboxentity.cpp b/src/render/defaults/qskyboxentity.cpp
index 740a3f14a..39a68723b 100644
--- a/src/render/defaults/qskyboxentity.cpp
+++ b/src/render/defaults/qskyboxentity.cpp
@@ -181,9 +181,9 @@ void QSkyboxEntityPrivate::reloadTexture()
/*!
* \class Qt3DRender::QSkyboxEntity
- * \inmodule Qt3DRenderer
+ * \inmodule Qt3DRender
*
- * \brief Qt3DCore::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can
+ * \brief Qt3DRender::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can
* be used to insert a skybox in a 3D scene.
*
* By specifying a base name and an extension, Qt3DCore::QSkyboxEntity
diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp
index d223c2ac0..6515cc0d1 100644
--- a/src/render/framegraph/qcameraselector.cpp
+++ b/src/render/framegraph/qcameraselector.cpp
@@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DRender::CameraSelector
+ \class Qt3DRender::QCameraSelector
+ \inmodule Qt3DRender
*/
/*! \internal */
@@ -81,6 +82,9 @@ QCameraSelector::~QCameraSelector()
QNode::cleanup();
}
+/*!
+ \property Qt3DRender::QCameraSelector::camera
+*/
void QCameraSelector::setCamera(Qt3DCore::QEntity *camera)
{
Q_D(QCameraSelector);
diff --git a/src/render/framegraph/qframegraph.cpp b/src/render/framegraph/qframegraph.cpp
index 080d83e48..c1a338211 100644
--- a/src/render/framegraph/qframegraph.cpp
+++ b/src/render/framegraph/qframegraph.cpp
@@ -56,13 +56,13 @@ QFrameGraphPrivate::QFrameGraphPrivate()
}
/*!
- \class FrameGraph
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QFrameGraph
+ \inmodule Qt3DRender
\since 5.3
- \brief Defines the rendering method to be used by the renderer
+ \brief Defines the rendering method to be used by the renderer.
- FrameGraph is the Component that has an activeFrameGraph property
+ QFrameGraph is the Component that has an activeFrameGraph property
that should reference the root FrameGraphItem of a frame graph
tree. The Entity that contains a FrameGraph property defines the
rendering method to be used by the renderer.
@@ -79,7 +79,9 @@ QFrameGraphPrivate::QFrameGraphPrivate()
\brief For OpenGL ...
*/
-/*! \fn void Qt3DRender::QFrameGraph::copy(const QNode *ref)
+/*!
+ \fn void Qt3DRender::QFrameGraph::copy(const Qt3DCore::QNode *ref)
+
Copies the \a ref instance into this one.
*/
void QFrameGraph::copy(const QNode *ref)
@@ -90,7 +92,8 @@ void QFrameGraph::copy(const QNode *ref)
}
/*!
- \fn Qt3DRender::QFrameGraph::QFrameGraph(QNode *parent)
+ \fn Qt3DRender::QFrameGraph::QFrameGraph(Qt3DCore::QNode *parent)
+
Constructs a new QFrameGraph with the specified \a parent.
*/
QFrameGraph::QFrameGraph(QNode *parent)
@@ -110,7 +113,7 @@ QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent)
}
/*!
- \qmlproperty Qt3D.Renderer::FrameGraphNode Qt3D.Renderer::FrameGraph::activeFrameGraph
+ \qmlproperty FrameGraphNode Qt3D.Render::FrameGraph::activeFrameGraph
Holds the current activeFrameGraph root node.
*/
diff --git a/src/render/framegraph/qframegraphnode.cpp b/src/render/framegraph/qframegraphnode.cpp
index acddc838e..18d191b38 100644
--- a/src/render/framegraph/qframegraphnode.cpp
+++ b/src/render/framegraph/qframegraphnode.cpp
@@ -52,8 +52,8 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate()
}
/*!
- \class QFrameGraphNode
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QFrameGraphNode
+ \inmodule Qt3DRender
\since 5.5
\brief Base class of all FrameGraph configuration nodes.
@@ -66,7 +66,7 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate()
/*!
\qmltype FrameGraphNode
\inqmlmodule Qt3D.Render
- \instantiates QFrameGraphNode
+ \instantiates Qt3DRender::QFrameGraphNode
\inherits Node
\since 5.5
\qmlabstract
@@ -108,7 +108,7 @@ QFrameGraphNode::QFrameGraphNode(QFrameGraphNodePrivate &dd, QNode *parent)
}
/*!
- \qmlproperty bool Qt3D.Renderer::FrameGraphNode::enabled
+ \qmlproperty bool Qt3D.Render::FrameGraphNode::enabled
Holds whether the frame graph node is enabled or disabled.
*/
diff --git a/src/render/framegraph/qframegraphselector.cpp b/src/render/framegraph/qframegraphselector.cpp
index 6d2dc7e6e..c612bd8ca 100644
--- a/src/render/framegraph/qframegraphselector.cpp
+++ b/src/render/framegraph/qframegraphselector.cpp
@@ -52,7 +52,7 @@ QFrameGraphSelectorPrivate::QFrameGraphSelectorPrivate()
/*!
\class Qt3DRender::QFrameGraphSelector
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\brief Qt3DRender::QFrameGraphSelector provide a way to select a one or more subtree of
the FrameGraph at runtime
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index 9c9ab58cd..1bb3fea09 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -52,8 +52,8 @@ QLayerFilterPrivate::QLayerFilterPrivate()
}
/*!
- \class QLayerFilter
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QLayerFilter
+ \inmodule Qt3DRender
\since 5.5
\brief The QLayerFilter class provides ...
*/
@@ -67,7 +67,7 @@ QLayerFilterPrivate::QLayerFilterPrivate()
\brief For ...
*/
-/*! \fn void Qt3DRender::QLayerFilter::copy(const QNode *ref)
+/*! \fn void Qt3DRender::QLayerFilter::copy(const Qt3DCore::QNode *ref)
Copies the \a ref instance into this one.
*/
void QLayerFilter::copy(const QNode *ref)
@@ -78,7 +78,7 @@ void QLayerFilter::copy(const QNode *ref)
}
-/*! \fn Qt3DRender::QLayerFilter::QLayerFilter(QNode *parent)
+/*! \fn Qt3DRender::QLayerFilter::QLayerFilter(Qt3DCore::QNode *parent)
Constructs a new QLayerFilter with the specified \a parent.
*/
QLayerFilter::QLayerFilter(QNode *parent)
@@ -103,7 +103,7 @@ QLayerFilter::QLayerFilter(QLayerFilterPrivate &dd, QNode *parent)
*/
/*!
- \qmlproperty stringlist Qt3D.Renderer::LayerFilter::layers
+ \qmlproperty stringlist Qt3D.Render::LayerFilter::layers
*/
diff --git a/src/render/framegraph/qnodraw.cpp b/src/render/framegraph/qnodraw.cpp
index 2e9137ffe..5d3b9107d 100644
--- a/src/render/framegraph/qnodraw.cpp
+++ b/src/render/framegraph/qnodraw.cpp
@@ -41,12 +41,13 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- * \class Qt3DRender::QNoDraw::QNoDraw
+ * \class Qt3DRender::QNoDraw
+ * \inmodule Qt3DRender
*
- * \brief When a Qt3DCore::QNoDraw node is present in a FrameGraph branch, this
+ * \brief When a QNoDraw node is present in a FrameGraph branch, this
* prevents the renderer from rendering any primitive.
*
- * Qt3DCore::QNoDraw should be used when the FrameGraph needs to set up some render
+ * QNoDraw should be used when the FrameGraph needs to set up some render
* states or clear some buffers without requiring any mesh to be drawn. It has
* the same effect as having a Qt3DRender::QRenderPassFilter that matches none of
* available Qt3DRender::QRenderPass instances of the scene without the overhead cost
diff --git a/src/render/framegraph/qstateset.cpp b/src/render/framegraph/qstateset.cpp
index 3e9bdbe0f..1ddded123 100644
--- a/src/render/framegraph/qstateset.cpp
+++ b/src/render/framegraph/qstateset.cpp
@@ -46,6 +46,10 @@ using namespace Qt3DCore;
namespace Qt3DRender {
+/*!
+ \class Qt3DRender::QStateSetPrivate
+ \internal
+*/
QStateSetPrivate::QStateSetPrivate()
: QFrameGraphNodePrivate()
{
@@ -55,19 +59,19 @@ QStateSetPrivate::QStateSetPrivate()
* \class Qt3DRender::QStateSet
* \inmodule Qt3DRender
*
- * \brief The Qt3DCore::QStateSet FrameGraph node offers a way of specifying a set
- * of Qt3DCore::QRenderState to be applied during the execution of a FrameGraph
- * branch.
+ * \brief The QStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of
+ * specifying a set of QRenderState objects to be applied during the execution
+ * of a framegraph branch.
*
- * States set on a Qt3DCore::QStateSet are set globally, contrary to the per
- * Material states that can be set on a Qt3DRender::QRenderPass. By default an empty
- * Qt3DCore::QStateSet will result in all render states being disabled when
- * executed. Adding a Qt3DCore::QRenderState state explicitly enables that render
+ * States set on a QStateSet are set globally, contrary to the per-material
+ * states that can be set on a QRenderPass. By default, an empty
+ * QStateSet will result in all render states being disabled when
+ * executed. Adding a QRenderState state explicitly enables that render
* state at runtime.
*
* \since 5.5
*
- * \sa Qt3DCore::QRenderState, Qt3DRender::QRenderPass
+ * \sa QRenderState, QRenderPass
*/
QStateSet::QStateSet(QNode *parent)
@@ -95,9 +99,9 @@ void QStateSet::copy(const QNode *ref)
}
/*!
- * Adds a new Qt3DCore::QRenderState \a state to the Qt3DCore::QStateSet instance.
+ * Adds a new QRenderState \a state to the QStateSet instance.
*
- * \note Not setting any Qt3DCore::QRenderState state on a Qt3DCore::QStateSet instance
+ * \note Not setting any QRenderState state on a QStateSet instance
* implies all the render states will be disabled at render time.
*/
void QStateSet::addRenderState(QRenderState *state)
@@ -121,7 +125,7 @@ void QStateSet::addRenderState(QRenderState *state)
}
/*!
- * Removes the Qt3DCore::QRenderState \a state from the Qt3DCore::QStateSet instance.
+ * Removes the QRenderState \a state from the QStateSet instance.
*/
void QStateSet::removeRenderState(QRenderState *state)
{
@@ -136,7 +140,7 @@ void QStateSet::removeRenderState(QRenderState *state)
}
/*!
- * Returns the list of Qt3DCore::QRenderState that compose the Qt3DCore::QStateSet instance.
+ * Returns the list of QRenderState objects that compose the QStateSet instance.
*/
QList<QRenderState *> QStateSet::renderStates() const
{
diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp
index 64e8faa22..107b9d250 100644
--- a/src/render/frontend/qlayer.cpp
+++ b/src/render/frontend/qlayer.cpp
@@ -51,8 +51,8 @@ QLayerPrivate::QLayerPrivate()
}
/*!
- \class QLayer
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QLayer
+ \inmodule Qt3DRender
\since 5.5
\brief The QLayer class provides ...
*/
@@ -67,7 +67,7 @@ QLayerPrivate::QLayerPrivate()
*/
-/*! \fn void Qt3DRender::QLayer::copy(const QNode *ref)
+/*! \fn void Qt3DRender::QLayer::copy(const Qt3DCore::QNode *ref)
Copies the \a ref instance into this one.
*/
void QLayer::copy(const QNode *ref)
@@ -77,7 +77,7 @@ void QLayer::copy(const QNode *ref)
d_func()->m_names = layer->d_func()->m_names;
}
-/*! \fn Qt3DRender::QLayer::QLayer(QObject *parent)
+/*! \fn Qt3DRender::QLayer::QLayer(Qt3DCore::QNode *parent)
Constructs a new QLayer with the specified \a parent.
*/
@@ -103,7 +103,7 @@ QLayer::QLayer(QLayerPrivate &dd, QNode *parent)
*/
/*!
- \qmlproperty stringlist Qt3D.Renderer::Layer::names
+ \qmlproperty stringlist Qt3D.Render::Layer::names
*/
diff --git a/src/render/io/qabstractsceneloader.cpp b/src/render/io/qabstractsceneloader.cpp
index debae5c89..6c90c15ad 100644
--- a/src/render/io/qabstractsceneloader.cpp
+++ b/src/render/io/qabstractsceneloader.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- \class Qt3DRender::Render::QAbstractSceneLoaderPrivate
+ \class Qt3DRender::QAbstractSceneLoaderPrivate
\internal
*/
QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate()
diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp
index a5f1a6c47..b0132e43a 100644
--- a/src/render/lights/qabstractlight.cpp
+++ b/src/render/lights/qabstractlight.cpp
@@ -45,7 +45,7 @@ namespace Qt3DRender
/*!
* \qmltype AbstractLight
* \inqmlmodule Qt3D.Render
- * \instantiates QAbstractLight
+ * \instantiates Qt3DRender::QAbstractLight
* \brief Encapsulate a QAbstractLight object in a Qt 3D scene.
* \since 5.3
*/
@@ -92,7 +92,7 @@ QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent)
/*!
- * \property Qt3DCore::QAbstractLight::color
+ * \property Qt3DRender::QAbstractLight::color
*
* Holds the current QAbstractLight color.
*/
@@ -112,7 +112,7 @@ void QAbstractLight::setColor(const QColor &color)
}
/*!
- \property Qt3DCore::QAbstractLight::intensity
+ \property Qt3DRender::QAbstractLight::intensity
Holds the current QAbstractLight intensity.
*/
@@ -132,7 +132,7 @@ void QAbstractLight::setIntensity(float intensity)
}
/*!
- \property Qt3DCore::QAbstractLight::position
+ \property Qt3DRender::QAbstractLight::position
Holds the current QAbstractLight position.
*/
diff --git a/src/render/lights/qdirectionallight.cpp b/src/render/lights/qdirectionallight.cpp
index c523215a9..2e3f91714 100644
--- a/src/render/lights/qdirectionallight.cpp
+++ b/src/render/lights/qdirectionallight.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
-/*!
+/*
*
* Expected Shader struct
*
diff --git a/src/render/lights/qpointlight.cpp b/src/render/lights/qpointlight.cpp
index 2fb6755cf..21ff60aa0 100644
--- a/src/render/lights/qpointlight.cpp
+++ b/src/render/lights/qpointlight.cpp
@@ -68,8 +68,8 @@ QPointLightPrivate::QPointLightPrivate()
}
/*!
- \class QPointLight
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QPointLight
+ \inmodule Qt3DRender
\since 5.5
*/
@@ -84,7 +84,7 @@ QPointLightPrivate::QPointLightPrivate()
*/
/*!
- \fn Qt3DRender::QPointLight::QPointLight(QNode *parent)
+ \fn Qt3DRender::QPointLight::QPointLight(Qt3DCore::QNode *parent)
Constructs a new QPointLight with the specified \a parent.
*/
QPointLight::QPointLight(QNode *parent)
diff --git a/src/render/lights/qspotlight.cpp b/src/render/lights/qspotlight.cpp
index b8f360bf4..ab0d822e7 100644
--- a/src/render/lights/qspotlight.cpp
+++ b/src/render/lights/qspotlight.cpp
@@ -73,8 +73,8 @@ QSpotLightPrivate::QSpotLightPrivate()
}
/*!
- \class QSpotLight
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QSpotLight
+ \inmodule Qt3DRender
\since 5.5
*/
@@ -88,7 +88,7 @@ QSpotLightPrivate::QSpotLightPrivate()
\brief For OpenGL ...
*/
-/*! \fn void Qt3DCore::QSpotLight::copy(const QNode *ref)
+/*! \fn void Qt3DRender::QSpotLight::copy(const Qt3DCore::QNode *ref)
Copies the \a ref instance into this one.
*/
@@ -104,7 +104,7 @@ void QSpotLight::copy(const QNode *ref)
/*!
- \fn Qt3DCore::QSpotLight::QSpotLight(QNode *parent)
+ \fn Qt3DRender::QSpotLight::QSpotLight(Qt3DCore::QNode *parent)
Constructs a new QSpotLight with the specified \a parent.
*/
QSpotLight::QSpotLight(QNode *parent)
@@ -119,12 +119,12 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent)
}
/*!
- \qmlproperty vector3d Qt3D.Renderer::SpotLight::direction
+ \qmlproperty vector3d Qt3D.Render::SpotLight::direction
*/
/*!
- \property Qt3DCore::QSpotLight::direction
+ \property Qt3DRender::QSpotLight::direction
*/
@@ -136,12 +136,12 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent)
/*!
- \qmlproperty float Qt3D.Renderer::SpotLight::cutOffAngle
+ \qmlproperty float Qt3D.Render::SpotLight::cutOffAngle
*/
/*!
- \property Qt3DCore::QSpotLight::cutOffAngle
+ \property Qt3DRender::QSpotLight::cutOffAngle
*/
float QSpotLight::cutOffAngle() const
diff --git a/src/render/materialsystem/qannotation.cpp b/src/render/materialsystem/qannotation.cpp
index 642e0c8c2..6c85da927 100644
--- a/src/render/materialsystem/qannotation.cpp
+++ b/src/render/materialsystem/qannotation.cpp
@@ -55,7 +55,7 @@ QAnnotationPrivate::QAnnotationPrivate()
/*!
\class Qt3DRender::QAnnotation
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief The QAnnotation class provides ...
*/
@@ -117,7 +117,7 @@ void QAnnotation::setName(const QString &name)
*/
/*!
- \qmlproperty variant Qt3D.Renderer::Annotation::value
+ \qmlproperty variant Qt3D.Render::Annotation::value
*/
QVariant QAnnotation::value() const
@@ -132,7 +132,7 @@ QVariant QAnnotation::value() const
*/
/*!
- \qmlproperty string Qt3D.Renderer::Annotation::name
+ \qmlproperty string Qt3D.Render::Annotation::name
*/
QString QAnnotation::name() const
diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp
index 21f5468f0..127426f62 100644
--- a/src/render/materialsystem/qgraphicsapifilter.cpp
+++ b/src/render/materialsystem/qgraphicsapifilter.cpp
@@ -280,9 +280,10 @@ void QGraphicsApiFilter::setVendor(const QString &vendor)
}
}
-/*! \fn bool Qt3DCore::operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
+/*! \fn bool Qt3DRender::operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
\relates Qt3DRender::QGraphicsApiFilter
- Returns true if \a reference and \a sample are equivalent.
+
+ Returns \c true if \a reference and \a sample are equivalent.
*/
bool operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
{
@@ -302,9 +303,10 @@ bool operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &
return false;
}
-/*! \fn bool Qt3DCore::operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
+/*! \fn bool Qt3DRender::operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
\relates Qt3DRender::QGraphicsApiFilter
- Returns true if \a reference and \a sample are different.
+
+ Returns \c true if \a reference and \a sample are different.
*/
bool operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample)
{
diff --git a/src/render/materialsystem/qmaterial.cpp b/src/render/materialsystem/qmaterial.cpp
index e0ab55019..48d7f3845 100644
--- a/src/render/materialsystem/qmaterial.cpp
+++ b/src/render/materialsystem/qmaterial.cpp
@@ -44,7 +44,7 @@
/*!
* \class Qt3DRender::QMaterial
- * \inmodule Qt3DRenderer
+ * \inmodule Qt3DRender
*
* \inherits Component
*
diff --git a/src/render/materialsystem/qparametermapping.cpp b/src/render/materialsystem/qparametermapping.cpp
index 1583983e2..95234889c 100644
--- a/src/render/materialsystem/qparametermapping.cpp
+++ b/src/render/materialsystem/qparametermapping.cpp
@@ -52,7 +52,7 @@ QParameterMappingPrivate::QParameterMappingPrivate()
}
/*!
\class Qt3DRender::QParameterMapping
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief The QParameterMapping class provides ...
*/
@@ -66,7 +66,7 @@ QParameterMappingPrivate::QParameterMappingPrivate()
\brief For ...
*/
-/*! \fn void Qt3DRender::QParameterMapping::copy(const QNode *ref)
+/*! \fn void Qt3DRender::QParameterMapping::copy(const Qt3DCore::QNode *ref)
Copies the \a ref instance into this one.
*/
void QParameterMapping::copy(const QNode *ref)
@@ -78,7 +78,7 @@ void QParameterMapping::copy(const QNode *ref)
d_func()->m_bindingType = mapper->d_func()->m_bindingType;
}
-/*! \fn Qt3DRender::QParameterMapping::QParameterMapping(QNode *parent)
+/*! \fn Qt3DRender::QParameterMapping::QParameterMapping(Qt3DCore::QNode *parent)
Constructs a new QParameterMapping with the specified \a parent.
*/
QParameterMapping::QParameterMapping(QNode *parent)
@@ -126,7 +126,7 @@ QParameterMapping::~QParameterMapping()
*/
/*!
- \qmlproperty string Qt3D.Renderer::ParameterMapping::parameterName
+ \qmlproperty string Qt3D.Render::ParameterMapping::parameterName
*/
@@ -145,7 +145,7 @@ void QParameterMapping::setParameterName(const QString &name)
*/
/*!
- \qmlproperty string Qt3D.Renderer::ParameterMapping::shaderVariableName
+ \qmlproperty string Qt3D.Render::ParameterMapping::shaderVariableName
*/
@@ -164,7 +164,7 @@ void QParameterMapping::setShaderVariableName(const QString &name)
*/
/*!
- \qmlproperty BindingType Qt3D.Renderer::ParameterMapping::bindingType
+ \qmlproperty BindingType Qt3D.Render::ParameterMapping::bindingType
\value Uniform
\value Attribute
diff --git a/src/render/materialsystem/qrenderpass.cpp b/src/render/materialsystem/qrenderpass.cpp
index 13cee24d0..b7d07f88f 100644
--- a/src/render/materialsystem/qrenderpass.cpp
+++ b/src/render/materialsystem/qrenderpass.cpp
@@ -105,7 +105,7 @@ ParameterList QRenderPass::uniforms() const
/*!
* Sets the pass's \a shaderProgram. This posts a ComponentUpdated
* QScenePropertyChange to the QChangeArbiter. The value is set to
- * the \a ShaderProgram and the property name to "shaderProgram".
+ * the \a shaderProgram and the property name to \c {"shaderProgram"}.
*/
void QRenderPass::setShaderProgram(QShaderProgram *shaderProgram)
{
diff --git a/src/render/materialsystem/qshaderdata.cpp b/src/render/materialsystem/qshaderdata.cpp
index 848b54bf8..87b7b2d74 100644
--- a/src/render/materialsystem/qshaderdata.cpp
+++ b/src/render/materialsystem/qshaderdata.cpp
@@ -51,10 +51,6 @@ QShaderDataPrivate::QShaderDataPrivate()
{
}
-/*!
- \class Qt3DRender::QShaderDataPrivate
- \internal
-*/
QShaderDataPrivate::QShaderDataPrivate(PropertyReaderInterfacePtr reader)
: QComponentPrivate()
, m_propertyReader(reader)
@@ -63,14 +59,15 @@ QShaderDataPrivate::QShaderDataPrivate(PropertyReaderInterfacePtr reader)
/*!
* \class Qt3DRender::QShaderData
- * \inmodule Qt3DRenderer
+ * \inmodule Qt3DRender
*
* \brief Provides a way of specifying values of a Uniform Block or a shader
* structure.
*
- * \note When subclassing and adding properties to Qt3DRender::QShaderData, please note
- * that if you need to nest an inner Qt3DRender::QShaderData, the data type of the
- * property should be Qt3DRender::QShaderData* instead of the name of your subclass.
+ * \note When subclassing and adding properties to QShaderData, note that if
+ * you need to nest an inner Qt3DRender::QShaderData, the data type of the
+ * property should be Qt3DRender::QShaderData* instead of the name of your
+ * subclass.
*
* \since 5.5
*/
diff --git a/src/render/materialsystem/qshaderprogram.cpp b/src/render/materialsystem/qshaderprogram.cpp
index e92a77d90..da0de2422 100644
--- a/src/render/materialsystem/qshaderprogram.cpp
+++ b/src/render/materialsystem/qshaderprogram.cpp
@@ -85,7 +85,7 @@ QShaderProgram::QShaderProgram(QShaderProgramPrivate &dd, QNode *parent)
}
/*!
- * Sets the vertexShader from raw data in \a vertexShader.
+ * Sets the vertex shader from raw data in \a vertexShaderCode.
*/
void QShaderProgram::setVertexShaderCode(const QByteArray &vertexShaderCode)
{
@@ -148,7 +148,7 @@ QByteArray QShaderProgram::geometryShaderCode() const
}
/*!
- * Sets the fragmentShader from raw data in \a fragmentShader.
+ * Sets the fragment shader from raw data in \a fragmentShaderCode.
*/
void QShaderProgram::setFragmentShaderCode(const QByteArray &fragmentShaderCode)
{
diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp
index da13baace..6213c6d0b 100644
--- a/src/render/picking/qobjectpicker.cpp
+++ b/src/render/picking/qobjectpicker.cpp
@@ -46,16 +46,17 @@ namespace Qt3DRender {
/*!
\class Qt3DRender::QObjectPicker
+ \inmodule Qt3DRender
- \brief The Qt3DRender::QObjectPicker class instantiates a component that can
- be used to interact with a Qt3DCore::QEntity by a process known as picking.
+ \brief The QObjectPicker class instantiates a component that can
+ be used to interact with a QEntity by a process known as picking.
- The signals pressed(), released(), clicked(), entered(), exited() are
+ The signals pressed(), released(), clicked(), entered(), and exited() are
emitted when the bounding volume defined by the pickAttribute property intersects
with a ray.
\note Instances of this component shouldn't be shared, not respecting that
- condition will most likely result in undefined behaviors.
+ condition will most likely result in undefined behavior.
\since 5.6
*/
@@ -80,9 +81,6 @@ namespace Qt3DRender {
\qmlsignal Qt3D.Render::ObjectPicker::exited()
*/
-/*!
- \internal
-*/
class QObjectPickerPrivate : public Qt3DCore::QComponentPrivate
{
public:
diff --git a/src/render/renderstates/qblendstate.cpp b/src/render/renderstates/qblendstate.cpp
index c507e9a5e..bc75aa3ce 100644
--- a/src/render/renderstates/qblendstate.cpp
+++ b/src/render/renderstates/qblendstate.cpp
@@ -66,7 +66,7 @@ public:
/*!
\class Qt3DRender::QBlendState
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates blending information.
*/
@@ -77,7 +77,7 @@ public:
\inherits RenderState
\inqmlmodule Qt3D.Render
\since 5.5
- \brief Encapsulates blending information
+ \brief Encapsulates blending information.
*/
/*!
@@ -93,7 +93,7 @@ QBlendState::~QBlendState()
QNode::cleanup();
}
-/*! \fn void QBlendState::copy(const QNode *ref)
+/*! \fn void QBlendState::copy(const Qt3DCore::QNode *ref)
\internal
Copies \a ref into this object.
*/
@@ -116,7 +116,7 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent)
}
/*!
- \enum Qt3DCore::QBlendState::Blending
+ \enum Qt3DRender::QBlendState::Blending
\value Zero 0
\value One 1
@@ -140,12 +140,12 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent)
*/
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::srcRGB
+ \qmlproperty enumeration Qt3D.Render::BlendState::srcRGB
*/
/*!
- \property Qt3DCore::QBlendState::srcRGB
+ \property Qt3DRender::QBlendState::srcRGB
*/
QBlendState::Blending QBlendState::srcRGB() const
@@ -164,12 +164,12 @@ void QBlendState::setSrcRGB(QBlendState::Blending srcRGB)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::dstRGB
+ \qmlproperty enumeration Qt3D.Render::BlendState::dstRGB
*/
/*!
- \property Qt3DCore::QBlendState::dstRGB
+ \property Qt3DRender::QBlendState::dstRGB
*/
QBlendState::Blending QBlendState::dstRGB() const
@@ -188,12 +188,12 @@ void QBlendState::setDstRGB(QBlendState::Blending dstRGB)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::srcAlpha
+ \qmlproperty enumeration Qt3D.Render::BlendState::srcAlpha
*/
/*!
- \property Qt3DCore::QBlendState::srcAlpha
+ \property Qt3DRender::QBlendState::srcAlpha
*/
QBlendState::Blending QBlendState::srcAlpha() const
@@ -212,12 +212,12 @@ void QBlendState::setSrcAlpha(QBlendState::Blending srcAlpha)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::dstAlpha
+ \qmlproperty enumeration Qt3D.Render::BlendState::dstAlpha
*/
/*!
- \property Qt3DCore::QBlendState::dstAlpha
+ \property Qt3DRender::QBlendState::dstAlpha
*/
QBlendState::Blending QBlendState::dstAlpha() const
@@ -236,8 +236,8 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha)
}
/*!
- \class QBlendStateSeparate
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QBlendStateSeparate
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates blending information.
*/
@@ -248,11 +248,11 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha)
\inherits RenderState
\inqmlmodule Qt3D.Render
\since 5.5
- \brief Encapsulates blending information
+ \brief Encapsulates blending information.
*/
/*!
- The constructor creates a QBlendStateSeparate with the
+ The constructor creates a QBlendStateSeparate instance with the
specified \a parent.
*/
QBlendStateSeparate::QBlendStateSeparate(QNode *parent)
diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp
index 3850a9dc7..94f2572fd 100644
--- a/src/render/renderstates/qclipplane.cpp
+++ b/src/render/renderstates/qclipplane.cpp
@@ -54,7 +54,7 @@ public:
/*!
\class Qt3DRender::QClipPlane
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\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 d517d30bc..4c9fabd78 100644
--- a/src/render/renderstates/qcolormask.cpp
+++ b/src/render/renderstates/qcolormask.cpp
@@ -62,7 +62,7 @@ public:
/*!
\class Qt3DRender::QColorMask
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\brief Allows specifying which color components should be written to the
currently bound frame buffer.
@@ -112,7 +112,7 @@ bool QColorMask::isAlpha() const
}
/*!
- \property Qt3DCore::QColorMask::red
+ \property Qt3DRender::QColorMask::red
Holds whether the red color component should be written to the frame buffer.
*/
void QColorMask::setRed(bool red)
@@ -125,7 +125,7 @@ void QColorMask::setRed(bool red)
}
/*!
- \property Qt3DCore::QColorMask::green
+ \property Qt3DRender::QColorMask::green
Holds whether the green color component should be written to the frame buffer.
*/
void QColorMask::setGreen(bool green)
@@ -138,7 +138,7 @@ void QColorMask::setGreen(bool green)
}
/*!
- \property Qt3DCore::QColorMask::blue
+ \property Qt3DRender::QColorMask::blue
Holds whether the blue color component should be written to the frame buffer.
*/
void QColorMask::setBlue(bool blue)
@@ -151,7 +151,7 @@ void QColorMask::setBlue(bool blue)
}
/*!
- \property Qt3DCore::QColorMask::alpha
+ \property Qt3DRender::QColorMask::alpha
Holds whether the alpha component should be written to the frame buffer.
*/
void QColorMask::setAlpha(bool alpha)
diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp
index ce4efeaf8..ef3414e62 100644
--- a/src/render/texture/qabstracttextureimage.cpp
+++ b/src/render/texture/qabstracttextureimage.cpp
@@ -60,8 +60,8 @@ namespace Qt3DRender {
*/
/*!
- \class QAbstractTextureImage
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QAbstractTextureImage
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture image.
@@ -79,7 +79,7 @@ namespace Qt3DRender {
*/
/*!
- Constructs a new Qt3DCore::QAbstractTextureImage instance with \a parent as parent.
+ Constructs a new QAbstractTextureImage instance with \a parent as parent.
*/
QAbstractTextureImage::QAbstractTextureImage(QNode *parent)
: QNode(*new QAbstractTextureImagePrivate, parent)
@@ -96,13 +96,13 @@ QAbstractTextureImage::~QAbstractTextureImage()
/*!
- \qmlproperty int Qt3D.render::AbstractTextureImage::mipmapLevel
+ \qmlproperty int Qt3D.Render::AbstractTextureImage::mipmapLevel
Holds the mipmap level of the texture image.
*/
/*!
- \property Qt3DCore::QAbstractTextureImage::mipmapLevel
+ \property Qt3DRender::QAbstractTextureImage::mipmapLevel
Holds the mipmap level of the texture image.
*/
@@ -113,13 +113,13 @@ int QAbstractTextureImage::mipmapLevel() const
}
/*!
- \qmlproperty int Qt3D.Renderer::AbstractTextureImage::layer
+ \qmlproperty int Qt3D.Render::AbstractTextureImage::layer
Holds the layer of the texture image.
*/
/*!
- \property Qt3DCore::QAbstractTextureImage::layer
+ \property Qt3DRender::QAbstractTextureImage::layer
Holds the layer of the texture image.
*/
@@ -130,7 +130,7 @@ int QAbstractTextureImage::layer() const
}
/*!
- \qmlproperty enumeration Qt3D.Renderer::AbstractTextureImage::cubeMapFace
+ \qmlproperty enumeration Qt3D.Render::AbstractTextureImage::cubeMapFace
Holds the cube map face of the texture image.
@@ -142,12 +142,12 @@ int QAbstractTextureImage::layer() const
\value CubeMapNegativeZ 0x851A GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
\note The cube map face has a meaning only for
- \l {QAbstractTextureProvider::}{TargetCubeMap} and
- \l {QAbstractTextureProvider::}{TargetCubeMapArray}.
+ \l [CPP] {Qt3DRender::QAbstractTextureProvider::}{TargetCubeMap} and
+ \l [CPP] {Qt3DRender::QAbstractTextureProvider::}{TargetCubeMapArray}.
*/
/*!
- \property Qt3DCore::QAbstractTextureImage::cubeMapFace
+ \property Qt3DRender::QAbstractTextureImage::cubeMapFace
Holds the cube map face of the texture image.
diff --git a/src/render/texture/qabstracttextureprovider.cpp b/src/render/texture/qabstracttextureprovider.cpp
index e85121f7f..2f91fd385 100644
--- a/src/render/texture/qabstracttextureprovider.cpp
+++ b/src/render/texture/qabstracttextureprovider.cpp
@@ -95,7 +95,7 @@ void QAbstractTextureProvider::copy(const QNode *ref)
\since 5.5
\brief A base class to be used to provide textures.
- Qt3DRender::QAbstractTextureProvider shouldn't be used directly but rather
+ The QAbstractTextureProvider class shouldn't be used directly but rather
through one of its subclasses. Each subclass implements a given texture
target (2D, 2DArray, 3D, CubeMap ...) Each subclass provides a set of
functors for each layer, cube map face and mipmap level. In turn the
@@ -103,7 +103,6 @@ void QAbstractTextureProvider::copy(const QNode *ref)
with data.
*/
-
QAbstractTextureProvider::QAbstractTextureProvider(QNode *parent)
: QNode(*new QAbstractTextureProviderPrivate, parent)
{
@@ -320,7 +319,7 @@ QAbstractTextureProvider::Target QAbstractTextureProvider::target() const
/*!
Adds a new Qt3DCore::QAbstractTextureImage \a textureImage to the texture provider.
- \note Qt3DCore::QAbstractTextureImage should never be shared between multiple
+ \note Qt3DRender::QAbstractTextureImage should never be shared between multiple
Qt3DRender::QAbstractTextureProvider instances.
*/
void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureImage)
diff --git a/src/render/texture/qtextureimage.cpp b/src/render/texture/qtextureimage.cpp
index 154f1e0aa..a069f6a56 100644
--- a/src/render/texture/qtextureimage.cpp
+++ b/src/render/texture/qtextureimage.cpp
@@ -97,8 +97,8 @@ private:
};
/*!
- \class QTextureImage
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QTextureImage
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture
image from an image source.
@@ -150,7 +150,7 @@ QUrl QTextureImage::source() const
*/
/*!
- \qmlproperty url Qt3D.Renderer::TextureImage::source
+ \qmlproperty url Qt3D.Render::TextureImage::source
This property holdsthe source url from which data for the texture
image will be loaded.
@@ -180,7 +180,7 @@ QTextureDataFunctorPtr QTextureImage::dataFunctor() const
}
/*!
- Copies \ref into this texture image.
+ Copies \a ref into this texture image.
*/
void QTextureImage::copy(const QNode *ref)
{
diff --git a/src/render/texture/qtextureproviders.cpp b/src/render/texture/qtextureproviders.cpp
index 62c8f66c7..1a42ebe9e 100644
--- a/src/render/texture/qtextureproviders.cpp
+++ b/src/render/texture/qtextureproviders.cpp
@@ -42,7 +42,7 @@ namespace Qt3DRender {
/*!
\class Qt3DRender::QTexture1D
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target1D target format.
*/
@@ -61,7 +61,7 @@ QTexture1D::~QTexture1D()
/*!
\class Qt3DRender::QTexture1DArray
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target1DArray target format.
*/
@@ -80,7 +80,7 @@ QTexture1DArray::~QTexture1DArray()
/*!
\class Qt3DRender::QTexture2D
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target2D target format.
*/
@@ -99,7 +99,7 @@ QTexture2D::~QTexture2D()
/*!
\class Qt3DRender::QTexture2DArray
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target2DArray target format.
*/
@@ -119,7 +119,7 @@ QTexture2DArray::~QTexture2DArray()
/*!
\class Qt3DRender::QTexture3D
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target3D target format.
*/
@@ -138,7 +138,7 @@ QTexture3D::~QTexture3D()
/*!
\class Qt3DRender::QTextureCubeMap
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a TargetCubeMap target format.
*/
@@ -157,7 +157,7 @@ QTextureCubeMap::~QTextureCubeMap()
/*!
\class Qt3DRender::QTextureCubeMapArray
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a TargetCubeMapArray target format.
*/
@@ -177,7 +177,7 @@ QTextureCubeMapArray::~QTextureCubeMapArray()
/*!
\class Qt3DRender::QTexture2DMultisample
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target2DMultisample target format.
*/
@@ -196,7 +196,7 @@ QTexture2DMultisample::~QTexture2DMultisample()
/*!
\class Qt3DRender::QTexture2DMultisampleArray
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a Target2DMultisampleArray target format.
*/
@@ -215,7 +215,7 @@ QTexture2DMultisampleArray::~QTexture2DMultisampleArray()
/*!
\class Qt3DRender::QTextureRectangle
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a TargetRectangle target format.
*/
@@ -234,7 +234,7 @@ QTextureRectangle::~QTextureRectangle()
/*!
\class Qt3DRender::QTextureBuffer
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief A QAbstractTextureProvider with a TargetBuffer target format.
*/
diff --git a/src/render/texture/qwrapmode.cpp b/src/render/texture/qwrapmode.cpp
index 2e5ace4d2..4baa6711b 100644
--- a/src/render/texture/qwrapmode.cpp
+++ b/src/render/texture/qwrapmode.cpp
@@ -60,7 +60,7 @@ public:
/*!
\class Qt3DRender::QTextureWrapMode
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief Defines the wrap mode a Qt3DRender::QAbstractTextureProvider