diff options
Diffstat (limited to 'src/core')
| -rw-r--r-- | src/core/nodes/qnode.cpp | 59 | ||||
| -rw-r--r-- | src/core/qray3d.cpp | 40 | ||||
| -rw-r--r-- | src/core/qscenepropertychange.cpp | 2 | ||||
| -rw-r--r-- | src/core/services/qabstractframeadvanceservice.cpp | 4 | ||||
| -rw-r--r-- | src/core/services/qeventfilterservice.cpp | 17 | ||||
| -rw-r--r-- | src/core/services/qsysteminformationservice.cpp | 4 | ||||
| -rw-r--r-- | src/core/services/qtickclockservice.cpp | 8 |
7 files changed, 64 insertions, 70 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()) |