From f55baa3a1c1b768f5010ebecda5589b3885ced27 Mon Sep 17 00:00:00 2001
From: Colin Ogilvie <colin.ogilvie@kdab.com>
Date: Thu, 26 May 2016 16:46:28 +0100
Subject: Doc for  core module

Task-number: QTBUG-46037
Change-Id: I187794f67a61e3e626e7992b0cfe211811823466
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
---
 src/core/aspects/qaspectengine.cpp                 |  3 +-
 src/core/changes/qcomponentaddedchange.cpp         | 27 +++++++++
 src/core/changes/qcomponentremovedchange.cpp       | 27 +++++++++
 src/core/changes/qdynamicpropertyupdatedchange.cpp | 17 ++++++
 src/core/changes/qnodecreatedchange.cpp            | 18 +++++-
 src/core/changes/qnodedestroyedchange.cpp          | 21 +++++++
 src/core/changes/qpropertynodeaddedchange.cpp      |  6 +-
 src/core/changes/qpropertynoderemovedchange.cpp    |  7 ++-
 src/core/changes/qpropertyupdatedchange.cpp        |  9 +--
 src/core/changes/qpropertyupdatedchangebase.cpp    |  4 +-
 src/core/changes/qpropertyvalueaddedchange.cpp     |  3 +-
 src/core/changes/qpropertyvalueaddedchangebase.cpp |  6 +-
 src/core/changes/qpropertyvalueremovedchange.cpp   |  7 ++-
 .../changes/qpropertyvalueremovedchangebase.cpp    |  6 +-
 src/core/changes/qscenechange.cpp                  | 21 ++++++-
 .../changes/qstaticpropertyupdatedchangebase.cpp   |  6 +-
 .../qstaticpropertyvalueaddedchangebase.cpp        | 10 ++++
 .../qstaticpropertyvalueremovedchangebase.cpp      | 10 ++++
 src/core/jobs/qaspectjob.cpp                       |  3 +-
 src/core/nodes/qbackendnode.cpp                    | 20 +------
 src/core/nodes/qnode.cpp                           | 66 +++++++++++-----------
 src/core/nodes/qnodeid.cpp                         |  3 +-
 src/core/transforms/qtransform.cpp                 |  6 +-
 23 files changed, 213 insertions(+), 93 deletions(-)

diff --git a/src/core/aspects/qaspectengine.cpp b/src/core/aspects/qaspectengine.cpp
index b94c53fc0..539806a4a 100644
--- a/src/core/aspects/qaspectengine.cpp
+++ b/src/core/aspects/qaspectengine.cpp
@@ -122,8 +122,7 @@ void QAspectEnginePrivate::generateCreationChanges(QNode *root)
  * \class Qt3DCore::QAspectEngine
  * \inherits QObject
  * \inmodule Qt3DCore
- *
- * TODO
+ * \brief Responsible for handling all the QAbstractAspect subclasses that have been registered with the scene.
  */
 
 /*!
diff --git a/src/core/changes/qcomponentaddedchange.cpp b/src/core/changes/qcomponentaddedchange.cpp
index 96e8e8562..1ad25651b 100644
--- a/src/core/changes/qcomponentaddedchange.cpp
+++ b/src/core/changes/qcomponentaddedchange.cpp
@@ -55,6 +55,24 @@ QComponentAddedChangePrivate::QComponentAddedChangePrivate(const QEntity *entity
 {
 }
 
+/*!
+ * \class Qt3DCore::QComponentAddedChange
+ * \inherits Qt3DCore::QSceneChange
+ * \inmodule Qt3DCore
+ * \brief The QComponentAddedChange class is used to notify when a component is added to an entity
+ *
+ */
+
+/*!
+ * \typedef Qt3DCore::QComponentAddedChangePtr
+ * \relates Qt3DCore::QComponentAddedChange
+ *
+ * A shared pointer for QComponentAddedChange.
+ */
+
+/*!
+ * Constructs a new QComponentAddedChange with with \a entity and  \a component.
+ */
 QComponentAddedChange::QComponentAddedChange(const QEntity *entity,
                                              const QComponent *component)
     : QSceneChange(*new QComponentAddedChangePrivate(entity, component),
@@ -66,18 +84,27 @@ QComponentAddedChange::~QComponentAddedChange()
 {
 }
 
+/*!
+  \return the id of the entity the component was added to.
+ */
 QNodeId QComponentAddedChange::entityId() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentAddedChange);
     return d->m_entityId;
 }
 
+/*!
+  \return the id of the component added.
+ */
 QNodeId QComponentAddedChange::componentId() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentAddedChange);
     return d->m_componentId;
 }
 
+/*!
+ * \return the metaobject.
+ */
 const QMetaObject *QComponentAddedChange::componentMetaObject() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentAddedChange);
diff --git a/src/core/changes/qcomponentremovedchange.cpp b/src/core/changes/qcomponentremovedchange.cpp
index ebee3c582..e1625ac93 100644
--- a/src/core/changes/qcomponentremovedchange.cpp
+++ b/src/core/changes/qcomponentremovedchange.cpp
@@ -55,6 +55,24 @@ QComponentRemovedChangePrivate::QComponentRemovedChangePrivate(const QEntity *en
 {
 }
 
+/*!
+ * \class Qt3DCore::QComponentRemovedChange
+ * \inherits Qt3DCore::QSceneChange
+ * \inmodule Qt3DCore
+ * \brief The QComponentRemovedChange class is used to notify when a component is removed from an entity
+ *
+ */
+
+/*!
+ * \typedef Qt3DCore::QComponentRemovedChangePtr
+ * \relates Qt3DCore::QComponentRemovedChange
+ *
+ * A shared pointer for QComponentRemovedChange.
+ */
+
+/*!
+ * Constructs a new QComponentRemovedChange with \a entity and  \a component.
+ */
 QComponentRemovedChange::QComponentRemovedChange(const QEntity *entity,
                                                  const QComponent *component)
     : QSceneChange(*new QComponentRemovedChangePrivate(entity, component),
@@ -66,18 +84,27 @@ QComponentRemovedChange::~QComponentRemovedChange()
 {
 }
 
+/*!
+  \return the id of the entity the component was removed from.
+ */
 QNodeId QComponentRemovedChange::entityId() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentRemovedChange);
     return d->m_entityId;
 }
 
+/*!
+  \return the id of the component removed.
+ */
 QNodeId QComponentRemovedChange::componentId() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentRemovedChange);
     return d->m_componentId;
 }
 
+/*!
+ * \return the metaobject.
+ */
 const QMetaObject *QComponentRemovedChange::componentMetaObject() const Q_DECL_NOTHROW
 {
     Q_D(const QComponentRemovedChange);
diff --git a/src/core/changes/qdynamicpropertyupdatedchange.cpp b/src/core/changes/qdynamicpropertyupdatedchange.cpp
index 491fffada..3931d942c 100644
--- a/src/core/changes/qdynamicpropertyupdatedchange.cpp
+++ b/src/core/changes/qdynamicpropertyupdatedchange.cpp
@@ -53,7 +53,24 @@ QDynamicPropertyUpdatedChangePrivate::~QDynamicPropertyUpdatedChangePrivate()
 {
 }
 
+/*!
+ * \class Qt3DCore::QDynamicPropertyUpdatedChange
+ * \inherits Qt3DCore::QPropertyUpdatedChangeBase
+ * \inmodule Qt3DCore
+ * \brief The QDynamicPropertyUpdatedChange class is used to notify when a dynamic property value is updated
+ *
+ */
 
+/*!
+ * \typedef Qt3DCore::QDynamicPropertyUpdatedChangePtr
+ * \relates Qt3DCore::QDynamicPropertyUpdatedChange
+ *
+ * A shared pointer for QDynamicPropertyUpdatedChange.
+ */
+
+/*!
+ * Constructs a new QDynamicPropertyUpdatedChange with \a subjectId.
+ */
 QDynamicPropertyUpdatedChange::QDynamicPropertyUpdatedChange(QNodeId subjectId)
     : QPropertyUpdatedChangeBase(*new QDynamicPropertyUpdatedChangePrivate, subjectId)
 {
diff --git a/src/core/changes/qnodecreatedchange.cpp b/src/core/changes/qnodecreatedchange.cpp
index d3036981f..891d21986 100644
--- a/src/core/changes/qnodecreatedchange.cpp
+++ b/src/core/changes/qnodecreatedchange.cpp
@@ -98,8 +98,14 @@ QNodeCreatedChangeBasePrivate::QNodeCreatedChangeBasePrivate(const QNode *node)
  * \class Qt3DCore::QNodeCreatedChangeBase
  * \inherits Qt3DCore::QSceneChange
  * \inmodule Qt3DCore
+ * \brief The QNodeCreatedChangeBase class is the base class for all NodeCreated QSceneChange events
  *
- * TODO
+ * The QNodeCreatedChangeBase class is the base class for all QSceneChange events that
+ * have the changeType() NodeCreated. You should not need to instantiate this class.
+ * Usually you should be using one of its subclasses such as QNodeCreatedChange.
+ *
+ * You can subclass this to create your own node update types for communication between
+ * your QNode and QBackendNode subclasses when writing your own aspects.
  */
 
 /*!
@@ -110,7 +116,7 @@ QNodeCreatedChangeBasePrivate::QNodeCreatedChangeBasePrivate(const QNode *node)
  */
 
 /*!
- * Constructs a new QNodeCreatedChangeBase with \a node and \a priority.
+ * Constructs a new QNodeCreatedChangeBase with \a node.
  */
 QNodeCreatedChangeBase::QNodeCreatedChangeBase(const QNode *node)
     : QSceneChange(*new QNodeCreatedChangeBasePrivate(node), NodeCreated, node->id())
@@ -155,4 +161,12 @@ bool QNodeCreatedChangeBase::isNodeEnabled() const Q_DECL_NOTHROW
 
 } // namespace Qt3DCore
 
+/*!
+ * \class Qt3DCore::QNodeCreatedChange
+ * \inherits Qt3DCore::QNodeCreatedChangeBase
+ * \since 5.7
+ * \inmodule Qt3DCore
+ * \brief Used to notify when a node is created.
+ */
+
 QT_END_NAMESPACE
diff --git a/src/core/changes/qnodedestroyedchange.cpp b/src/core/changes/qnodedestroyedchange.cpp
index 8f1331334..96403f237 100644
--- a/src/core/changes/qnodedestroyedchange.cpp
+++ b/src/core/changes/qnodedestroyedchange.cpp
@@ -41,6 +41,24 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DCore {
 
+/*!
+ * \class Qt3DCore::QNodeDestroyedChange
+ * \inherits Qt3DCore::QSceneChange
+ * \since 5.7
+ * \inmodule Qt3DCore
+ * \brief Used to notify when a node is destroyed.
+ */
+
+/*!
+ * \typedef Qt3DCore::QNodeDestroyedChangePtr
+ * \relates Qt3DCore::QNodeDestroyedChange
+ *
+ * A shared pointer for QNodeDestroyedChange.
+ */
+
+/*!
+ * Constructs a new QNodeDestroyedChange with \a node and its \a subtreeIdsAndTypes.
+ */
 QNodeDestroyedChange::QNodeDestroyedChange(const QNode *node, const QVector<QNodeIdTypePair> &subtreeIdsAndTypes)
     : QSceneChange(*new QNodeDestroyedChangePrivate, NodeDeleted, node->id())
 {
@@ -52,6 +70,9 @@ QNodeDestroyedChange::~QNodeDestroyedChange()
 {
 }
 
+/*!
+   \return a vector of subtree node id type pairs
+ */
 QVector<QNodeIdTypePair> QNodeDestroyedChange::subtreeIdsAndTypes() const
 {
     Q_D(const QNodeDestroyedChange);
diff --git a/src/core/changes/qpropertynodeaddedchange.cpp b/src/core/changes/qpropertynodeaddedchange.cpp
index 5f1a1f921..539c6a54a 100644
--- a/src/core/changes/qpropertynodeaddedchange.cpp
+++ b/src/core/changes/qpropertynodeaddedchange.cpp
@@ -53,9 +53,10 @@ QPropertyNodeAddedChangePrivate::QPropertyNodeAddedChangePrivate()
 
 /*!
  * \class Qt3DCore::QPropertyNodeAddedChange
+ * \inherits Qt3DCore::QStaticPropertyValueAddedChangeBase
  * \inmodule Qt3DCore
+ * \brief Used to notify when a node is added to a property
  *
- * TODO
  */
 
 /*!
@@ -66,8 +67,7 @@ QPropertyNodeAddedChangePrivate::QPropertyNodeAddedChangePrivate()
  */
 
 /*!
- * Constructs a new QPropertyNodeAddedChange with \a subjectId, \a addedNodeId, and
- * \a priority.
+ * Constructs a new QPropertyNodeAddedChange with \a subjectId, \a node.
  */
 QPropertyNodeAddedChange::QPropertyNodeAddedChange(QNodeId subjectId, QNode *node)
     : QStaticPropertyValueAddedChangeBase(*new QPropertyNodeAddedChangePrivate, subjectId)
diff --git a/src/core/changes/qpropertynoderemovedchange.cpp b/src/core/changes/qpropertynoderemovedchange.cpp
index ed13faaad..ac1c4b313 100644
--- a/src/core/changes/qpropertynoderemovedchange.cpp
+++ b/src/core/changes/qpropertynoderemovedchange.cpp
@@ -53,11 +53,13 @@ QPropertyNodeRemovedChangePrivate::QPropertyNodeRemovedChangePrivate()
 
 /*!
  * \class Qt3DCore::QPropertyNodeRemovedChange
+ * \inherits Qt3DCore::QStaticPropertyValueRemovedChangeBase
  * \inmodule Qt3DCore
+ * \brief The QPropertyNodeRemovedChange class is used to notify when a node is removed from a property
  *
- * TODO
  */
 
+
 /*!
  * \typedef Qt3DCore::QPropertyNodeRemovedChangePtr
  * \relates Qt3DCore::QPropertyNodeRemovedChange
@@ -66,8 +68,7 @@ QPropertyNodeRemovedChangePrivate::QPropertyNodeRemovedChangePrivate()
  */
 
 /*!
- * Constructs a new QPropertyNodeRemovedChange with \a subjectId, \a node, and
- * \a priority.
+ * Constructs a new QPropertyNodeRemovedChange with \a subjectId, \a node.
  */
 QPropertyNodeRemovedChange::QPropertyNodeRemovedChange(QNodeId subjectId, QNode *node)
     : QStaticPropertyValueRemovedChangeBase(*new QPropertyNodeRemovedChangePrivate, subjectId)
diff --git a/src/core/changes/qpropertyupdatedchange.cpp b/src/core/changes/qpropertyupdatedchange.cpp
index 8bb7290ab..66e7461b9 100644
--- a/src/core/changes/qpropertyupdatedchange.cpp
+++ b/src/core/changes/qpropertyupdatedchange.cpp
@@ -44,10 +44,6 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DCore {
 
-/*!
-    \class Qt3DCore::QPropertyUpdatedChange
-    \inmodule Qt3DCore
-*/
 QPropertyUpdatedChangePrivate::QPropertyUpdatedChangePrivate()
     : QStaticPropertyUpdatedChangeBasePrivate()
 {
@@ -59,9 +55,10 @@ QPropertyUpdatedChangePrivate::~QPropertyUpdatedChangePrivate()
 
 /*!
  * \class Qt3DCore::QPropertyUpdatedChange
+ * \inherits Qt3DCore::QStaticPropertyUpdatedChangeBase
  * \inmodule Qt3DCore
+ * \brief The QPropertyUpdatedChange class is used to notify when a property value is updated
  *
- * TODO
  */
 
 /*!
@@ -72,7 +69,7 @@ QPropertyUpdatedChangePrivate::~QPropertyUpdatedChangePrivate()
  */
 
 /*!
- * Constructs a new QPropertyUpdatedChange with \a subjectId and \a priority.
+ * Constructs a new QPropertyUpdatedChange with \a subjectId.
  */
 QPropertyUpdatedChange::QPropertyUpdatedChange(QNodeId subjectId)
     : QStaticPropertyUpdatedChangeBase(*new QPropertyUpdatedChangePrivate, subjectId)
diff --git a/src/core/changes/qpropertyupdatedchangebase.cpp b/src/core/changes/qpropertyupdatedchangebase.cpp
index fa6937921..ab278c3f4 100644
--- a/src/core/changes/qpropertyupdatedchangebase.cpp
+++ b/src/core/changes/qpropertyupdatedchangebase.cpp
@@ -56,6 +56,7 @@ QPropertyUpdatedChangeBasePrivate::~QPropertyUpdatedChangeBasePrivate()
 /*!
  * \class Qt3DCore::QPropertyUpdatedChangeBase
  * \inmodule Qt3DCore
+ * \brief The QPropertyUpdatedChangeBase class is the base class for all PropertyUpdated QSceneChange events
  *
  * The QPropertyUpdatedChangeBase class is the base class for all QSceneChange events that
  * have the changeType() PropertyUpdated. You should not need to instantiate this class.
@@ -74,8 +75,7 @@ QPropertyUpdatedChangeBasePrivate::~QPropertyUpdatedChangeBasePrivate()
  */
 
 /*!
- * Constructs a new QPropertyUpdatedChangeBase with \a senderType, \a subjectId, and
- * \a priority.
+ * Constructs a new QPropertyUpdatedChangeBase with \a subjectId
  */
 QPropertyUpdatedChangeBase::QPropertyUpdatedChangeBase(QNodeId subjectId)
     : QSceneChange(*new QPropertyUpdatedChangeBasePrivate, PropertyUpdated, subjectId)
diff --git a/src/core/changes/qpropertyvalueaddedchange.cpp b/src/core/changes/qpropertyvalueaddedchange.cpp
index ae83fe382..3c1fb7c62 100644
--- a/src/core/changes/qpropertyvalueaddedchange.cpp
+++ b/src/core/changes/qpropertyvalueaddedchange.cpp
@@ -52,9 +52,10 @@ QPropertyValueAddedChangePrivate::QPropertyValueAddedChangePrivate()
 
 /*!
  * \class Qt3DCore::QPropertyValueAddedChange
+ * \inherits Qt3DCore::QStaticPropertyValueAddedChangeBase
  * \inmodule Qt3DCore
+ * \brief Used to notify when a value is added to a property
  *
- * TODO
  */
 
 /*!
diff --git a/src/core/changes/qpropertyvalueaddedchangebase.cpp b/src/core/changes/qpropertyvalueaddedchangebase.cpp
index ae406ffae..cff918d80 100644
--- a/src/core/changes/qpropertyvalueaddedchangebase.cpp
+++ b/src/core/changes/qpropertyvalueaddedchangebase.cpp
@@ -56,6 +56,7 @@ QPropertyValueAddedChangeBasePrivate::~QPropertyValueAddedChangeBasePrivate()
 /*!
  * \class Qt3DCore::QPropertyValueAddedChangeBase
  * \inmodule Qt3DCore
+ * \brief The QPropertyValueAddedChangeBase class is the base class for all PropertyValueAdded QSceneChange events
  *
  * The QPropertyValueAddedChangeBase class is the base class for all QSceneChange events that
  * have the changeType() PropertyValueAdded. You should not need to instantiate this class.
@@ -73,15 +74,14 @@ QPropertyValueAddedChangeBasePrivate::~QPropertyValueAddedChangeBasePrivate()
  */
 
 /*!
- * Constructs a new QPropertyValueAddedChangeBase with \a senderType, \a subjectId, and
- * \a priority.
+ * Constructs a new QPropertyValueAddedChangeBase with \a subjectId
  */
 QPropertyValueAddedChangeBase::QPropertyValueAddedChangeBase(QNodeId subjectId)
     : QSceneChange(*new QPropertyValueAddedChangeBasePrivate, PropertyValueAdded, subjectId)
 {
 }
 
-/*! internal */
+/*! \internal */
 QPropertyValueAddedChangeBase::QPropertyValueAddedChangeBase(QPropertyValueAddedChangeBasePrivate &dd,
                                                              QNodeId subjectId)
     : QSceneChange(dd, PropertyValueAdded, subjectId)
diff --git a/src/core/changes/qpropertyvalueremovedchange.cpp b/src/core/changes/qpropertyvalueremovedchange.cpp
index 72092a55c..2512e4785 100644
--- a/src/core/changes/qpropertyvalueremovedchange.cpp
+++ b/src/core/changes/qpropertyvalueremovedchange.cpp
@@ -52,9 +52,10 @@ QPropertyValueRemovedChangePrivate::QPropertyValueRemovedChangePrivate()
 
 /*!
  * \class Qt3DCore::QPropertyValueRemovedChange
+ * \inherits Qt3DCore::QStaticPropertyValueRemovedChangeBase
  * \inmodule Qt3DCore
+ * \brief Used to notify when a value is added to a property
  *
- * TODO
  */
 
 /*!
@@ -77,7 +78,7 @@ QPropertyValueRemovedChange::~QPropertyValueRemovedChange()
 }
 
 /*!
- * Sets the value Removed to the property to \a value.
+ * Sets the value removed from the property to \a value.
  */
 void QPropertyValueRemovedChange::setRemovedValue(const QVariant &value)
 {
@@ -86,7 +87,7 @@ void QPropertyValueRemovedChange::setRemovedValue(const QVariant &value)
 }
 
 /*!
- * \return the value Removed to the property.
+ * \return the value removed from the property.
  */
 QVariant QPropertyValueRemovedChange::removedValue() const
 {
diff --git a/src/core/changes/qpropertyvalueremovedchangebase.cpp b/src/core/changes/qpropertyvalueremovedchangebase.cpp
index 0892aa7c2..0a62c43c8 100644
--- a/src/core/changes/qpropertyvalueremovedchangebase.cpp
+++ b/src/core/changes/qpropertyvalueremovedchangebase.cpp
@@ -56,6 +56,7 @@ QPropertyValueRemovedChangeBasePrivate::~QPropertyValueRemovedChangeBasePrivate(
 /*!
  * \class Qt3DCore::QPropertyValueRemovedChangeBase
  * \inmodule Qt3DCore
+ * \brief The QPropertyValueRemovedChangeBase class is the base class for all PropertyValueRemoved QSceneChange events
  *
  * The QPropertyValueRemovedChangeBase class is the base class for all QSceneChange events that
  * have the changeType() PropertyValueRemoved. You should not need to instantiate this class.
@@ -73,15 +74,14 @@ QPropertyValueRemovedChangeBasePrivate::~QPropertyValueRemovedChangeBasePrivate(
  */
 
 /*!
- * Constructs a new QPropertyValueRemovedChangeBase with \a senderType, \a subjectId, and
- * \a priority.
+ * Constructs a new QPropertyValueRemovedChangeBase with \a subjectId
  */
 QPropertyValueRemovedChangeBase::QPropertyValueRemovedChangeBase(QNodeId subjectId)
     : QSceneChange(*new QPropertyValueRemovedChangeBasePrivate, PropertyValueRemoved, subjectId)
 {
 }
 
-/*! internal */
+/*! \internal */
 QPropertyValueRemovedChangeBase::QPropertyValueRemovedChangeBase(QPropertyValueRemovedChangeBasePrivate &dd,
                                                                  QNodeId subjectId)
     : QSceneChange(dd, PropertyValueRemoved, subjectId)
diff --git a/src/core/changes/qscenechange.cpp b/src/core/changes/qscenechange.cpp
index 27b3e0a7b..311c26340 100644
--- a/src/core/changes/qscenechange.cpp
+++ b/src/core/changes/qscenechange.cpp
@@ -75,8 +75,7 @@ QSceneChangePrivate::~QSceneChangePrivate()
 /*!
  * \class Qt3DCore::QSceneChange
  * \inmodule Qt3DCore
- *
- * TODO
+ * \brief The base class for changes that can be sent and received by Qt3D's change notification system
  */
 
 /*!
@@ -87,7 +86,17 @@ QSceneChangePrivate::~QSceneChangePrivate()
  */
 
 /*!
- * Constructs a new QSceneChange with \a type, \a senderType, \a subjectId, and \a priority.
+ * \enum QSceneChange::DeliveryFlag
+ *
+ * The types of change that can be sent and received by Qt3D's change notification system.
+ *
+ * \value BackendNodes
+ * \value Nodes
+ * \value DeliverToAll
+ */
+
+/*!
+ * Constructs a new QSceneChange with \a type and \a subjectId.
  */
 QSceneChange::QSceneChange(ChangeFlag type, QNodeId subjectId)
     : d_ptr(new QSceneChangePrivate)
@@ -123,12 +132,18 @@ ChangeFlag QSceneChange::type() const Q_DECL_NOTHROW
     return d->m_type;
 }
 
+/*!
+  Set the Delivery flags of the change to \a flags
+  */
 void QSceneChange::setDeliveryFlags(DeliveryFlags flags) Q_DECL_NOTHROW
 {
     Q_D(QSceneChange);
     d->m_deliveryFlags = flags;
 }
 
+/*!
+ \return the set delivery flags
+ */
 QSceneChange::DeliveryFlags QSceneChange::deliveryFlags() const Q_DECL_NOTHROW
 {
     Q_D(const QSceneChange);
diff --git a/src/core/changes/qstaticpropertyupdatedchangebase.cpp b/src/core/changes/qstaticpropertyupdatedchangebase.cpp
index 1da01e89e..8beae634b 100644
--- a/src/core/changes/qstaticpropertyupdatedchangebase.cpp
+++ b/src/core/changes/qstaticpropertyupdatedchangebase.cpp
@@ -57,8 +57,9 @@ QStaticPropertyUpdatedChangeBasePrivate::~QStaticPropertyUpdatedChangeBasePrivat
 /*!
  * \class Qt3DCore::QStaticPropertyUpdatedChangeBase
  * \inmodule Qt3DCore
+ * \since 5.7
+ * \brief The QStaticPropertyUpdatedChangeBase class is the base class for all static PropertyUpdated QSceneChange events
  *
- * TODO
  */
 
 /*!
@@ -69,8 +70,7 @@ QStaticPropertyUpdatedChangeBasePrivate::~QStaticPropertyUpdatedChangeBasePrivat
  */
 
 /*!
- * Constructs a new QStaticPropertyUpdatedChangeBase with \a type, \a senderType, \a subjectId, and
- * \a priority.
+ * Constructs a new QStaticPropertyUpdatedChangeBase with \a subjectId
  */
 QStaticPropertyUpdatedChangeBase::QStaticPropertyUpdatedChangeBase(QNodeId subjectId)
     : QPropertyUpdatedChangeBase(*new QStaticPropertyUpdatedChangeBasePrivate, subjectId)
diff --git a/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp b/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp
index 108c8d5c4..20d2af032 100644
--- a/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp
+++ b/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp
@@ -49,7 +49,17 @@ QStaticPropertyValueAddedChangeBasePrivate::QStaticPropertyValueAddedChangeBaseP
 {
 }
 
+/*!
+ * \class Qt3DCore::QStaticPropertyValueAddedChangeBase
+ * \inmodule Qt3DCore
+ * \since 5.7
+ * \brief The QStaticPropertyValueAddedChangeBase class is the base class for all static PropertyValueAdded QSceneChange events
+ *
+ */
 
+/*!
+ * Constructs a new QStaticPropertyValueAddedChangeBase with \a subjectId
+ */
 QStaticPropertyValueAddedChangeBase::QStaticPropertyValueAddedChangeBase(QNodeId subjectId)
     : QPropertyValueAddedChangeBase(*new QStaticPropertyValueAddedChangeBasePrivate, subjectId)
 {
diff --git a/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp b/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp
index 9eff24b65..0891abba8 100644
--- a/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp
+++ b/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp
@@ -49,7 +49,17 @@ QStaticPropertyValueRemovedChangeBasePrivate::QStaticPropertyValueRemovedChangeB
 {
 }
 
+/*!
+ * \class Qt3DCore::QStaticPropertyValueRemovedChangeBase
+ * \inmodule Qt3DCore
+ * \since 5.7
+ * \brief The QStaticPropertyValueRemovedChangeBase class is the base class for all static PropertyValueRemoved QSceneChange events
+ *
+ */
 
+/*!
+ * Constructs a new QStaticPropertyValueRemovedChangeBase with \a subjectId
+ */
 QStaticPropertyValueRemovedChangeBase::QStaticPropertyValueRemovedChangeBase(QNodeId subjectId)
     : QPropertyValueRemovedChangeBase(*new QStaticPropertyValueRemovedChangeBasePrivate, subjectId)
 {
diff --git a/src/core/jobs/qaspectjob.cpp b/src/core/jobs/qaspectjob.cpp
index 539ae78bf..94a747867 100644
--- a/src/core/jobs/qaspectjob.cpp
+++ b/src/core/jobs/qaspectjob.cpp
@@ -71,8 +71,7 @@ QAspectJob::QAspectJob()
 /*!
  * \class Qt3DCore::QAspectJob
  * \inmodule Qt3DCore
- *
- * TODO
+ * \brief The base class for jobs executed in an aspect
  */
 
 /*!
diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp
index 6cac981ae..d8289df63 100644
--- a/src/core/nodes/qbackendnode.cpp
+++ b/src/core/nodes/qbackendnode.cpp
@@ -96,17 +96,7 @@ QBackendNodePrivate *QBackendNodePrivate::get(QBackendNode *n)
  * \class Qt3DCore::QBackendNodeMapper
  * \inmodule Qt3DCore
  *
- * TODO
- */
-
-/*!
- * \fn QBackendNode *QBackendNodeMapper::create(QNode *frontend) const
- *
- * TODO
- *
- * \a frontend
- *
- * \return created node.
+ * \brief Creates and maps backend nodes to their respective frontend nodes
  */
 
 /*!
@@ -135,13 +125,7 @@ QBackendNodePrivate *QBackendNodePrivate::get(QBackendNode *n)
  * \class Qt3DCore::QBackendNode
  * \inmodule Qt3DCore
  *
- * TODO
- */
-
-/*!
- * \fn void Qt3DCore::QBackendNode::updateFromPeer(QNode *peer)
- *
- * Updates the backend node from \a peer.
+ * \brief The base class for all Qt3D backend nodes
  */
 
 /*!
diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp
index 9b718da4b..c291d9503 100644
--- a/src/core/nodes/qnode.cpp
+++ b/src/core/nodes/qnode.cpp
@@ -431,6 +431,33 @@ void QNodePrivate::setArbiter(QLockableObserverInterface *arbiter)
         registerNotifiedProperties();
 }
 
+/*!
+    \class Qt3DCore::QNode
+    \inherits QObject
+
+    \inmodule Qt3DCore
+    \since 5.5
+
+    \brief QNode is the base class of all Qt3D node classes used to build a
+    Qt3D scene.
+
+    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 QNode instance can only be another QNode instance.
+
+    Each QNode instance has a unique id that allows it to be recognizable
+    from other instances.
+
+    When properties are defined on a QNode subclass, their NOTIFY signal
+    will automatically generate notifications that the Qt3D backend aspects will
+    receive.
+
+    \sa QEntity, QComponent
+*/
+
 /*!
  * Sends the \a change QSceneChangePtr to any QBackendNodes in the registered
  * aspects that correspond to this QNode.
@@ -568,39 +595,6 @@ void QNodePrivate::nodePtrDeleter(QNode *q)
     p->deleteLater();
 }
 
-
-/*!
-    \class Qt3DCore::QNode
-    \inherits QObject
-
-    \inmodule Qt3DCore
-    \since 5.5
-
-    \brief QNode is the base class of all Qt3D node classes used to build a
-    Qt3D scene.
-
-    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 QNode instance can only be another QNode instance.
-
-    Each QNode instance has a unique id that allows it to be recognizable
-    from other instances.
-
-    When properties are defined on a QNode subclass, their NOTIFY signal
-    will automatically generate notifications that the Qt3D backend aspects will
-    receive.
-
-    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 QNode subclass
-    instance is eventually destroyed.
-
-    \sa QEntity, QComponent
-*/
-
 /*!
     \fn QNodeId qIdForNode(QNode *node)
     \relates Qt3DCore::QNode
@@ -633,6 +627,12 @@ QNode::QNode(QNodePrivate &dd, QNode *parent)
     d->init(parent);
 }
 
+/*!
+    \fn QNode::nodeDestroyed()
+    emitted when the node is destroyed.
+*/
+
+/*! \internal */
 QNode::~QNode()
 {
     Q_D(QNode);
diff --git a/src/core/nodes/qnodeid.cpp b/src/core/nodes/qnodeid.cpp
index 306ec0443..dee5d4ff4 100644
--- a/src/core/nodes/qnodeid.cpp
+++ b/src/core/nodes/qnodeid.cpp
@@ -46,8 +46,7 @@ namespace Qt3DCore {
 /*!
  * \class Qt3DCore::QNodeId
  * \inmodule Qt3DCore
- *
- * TODO
+ * \brief Uniquely identifies a QNode
  */
 
 /*!
diff --git a/src/core/transforms/qtransform.cpp b/src/core/transforms/qtransform.cpp
index 55974a836..f96267b74 100644
--- a/src/core/transforms/qtransform.cpp
+++ b/src/core/transforms/qtransform.cpp
@@ -67,8 +67,7 @@ QTransformPrivate::~QTransformPrivate()
  * \inherits Component3D
  * \instantiates Qt3DCore::QComponent
  * \since 5.6
- *
- * TODO
+ * \brief Used to perform transforms on meshes
  */
 
 /*!
@@ -170,8 +169,7 @@ QTransformPrivate::~QTransformPrivate()
  * \inmodule Qt3DCore
  * \inherits Qt3DCore::QComponent
  * \since 5.6
- *
- * TODO
+ * \brief Used to perform transforms on meshes
  */
 
 /*!
-- 
cgit v1.2.3