Doc: Add doc to undocumented methods

- qcomponent.cpp
- qbackendnode.cpp
- qjoint.cpp
- qskeletonloader.cpp
- qframeaction.cpp
- qscene2d.h
- qrenderaspect.cpp

Change-Id: I25881dee19d2d01f948bfaf4a156a97f6caaea73
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>

7 files changed, 52 insertions, 1 deletions

diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp
index 62ca14b4b..f10bf5769 100644
--- a/src/core/nodes/qbackendnode.cpp
+++ b/src/core/nodes/qbackendnode.cpp
@@ -207,6 +207,11 @@ void QBackendNode::notifyObservers(const QSceneChangePtr &e)
     d->notifyObservers(e);
 }
 
+/*!
+    Send the command named \a name with contents \a data,
+    and specify \a replyTo as the command id to which the
+    reply needs to be sent.
+*/
 QNodeCommand::CommandId QBackendNode::sendCommand(const QString &name,
                                                   const QVariant &data,
                                                   QNodeCommand::CommandId replyTo)
@@ -220,6 +225,9 @@ QNodeCommand::CommandId QBackendNode::sendCommand(const QString &name,
     return e->commandId();
 }
 
+/*!
+    Send the reply to \a command.
+*/
 void QBackendNode::sendReply(const QNodeCommandPtr &command)
 {
     command->setDeliveryFlags(QSceneChange::Nodes);
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index f4e59e058..e678880e8 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -112,6 +112,17 @@ void QComponentPrivate::removeEntity(QEntity *entity)
 */
 
 /*!
+    \fn Qt3DCore::QComponent::addedToEntity(Qt3DCore::QEntity *entity)'
+
+    Indicates that a reference has been added to \a entity.
+*/
+/*!
+    \fn Qt3DCore::QComponent::removedFromEntity(Qt3DCore::QEntity *entity)
+
+    Indicates that a reference has been removed from \a entity.
+
+*/
+/*!
     Constructs a new QComponent instance with \a parent as the parent.
     \note a QComponent should never be instanced directly,
     instance one of the subclasses instead.
diff --git a/src/core/transforms/qjoint.cpp b/src/core/transforms/qjoint.cpp
index c9e672cef..017773ff6 100644
--- a/src/core/transforms/qjoint.cpp
+++ b/src/core/transforms/qjoint.cpp
@@ -325,6 +325,9 @@ void QJoint::setName(const QString &name)
     emit nameChanged(name);
 }
 
+/*!
+    Sets the transform matrix for this joint to the identity matrix.
+*/
 void QJoint::setToIdentity()
 {
     setScale(QVector3D(1.0f, 1.0f, 1.0f));
@@ -388,6 +391,9 @@ QVector<QJoint *> QJoint::childJoints() const
     return d->m_childJoints;
 }
 
+/*!
+    Returns the name of the joint.
+*/
 QString QJoint::name() const
 {
     Q_D(const QJoint);
diff --git a/src/core/transforms/qskeletonloader.cpp b/src/core/transforms/qskeletonloader.cpp
index 00026ecf5..a917252d9 100644
--- a/src/core/transforms/qskeletonloader.cpp
+++ b/src/core/transforms/qskeletonloader.cpp
@@ -120,7 +120,10 @@ void QSkeletonLoaderPrivate::setStatus(QSkeletonLoader::Status status)
     \value Ready                 The skeleton was successfully loaded
     \value Error                 An error occurred while loading the skeleton
 */
+/*!
+    \property Qt3DCore::QSkeletonLoader::createJointsEnabled
 
+    \brief A boolean to indicate whether createJoints is enabled or not.
 /*!
     Constructs a new QSkeletonLoader with \a parent.
 */
@@ -171,12 +174,19 @@ QSkeletonLoader::Status QSkeletonLoader::status() const
     return d->m_status;
 }
 
+/*!
+    Returns a boolean indicating whether CreateJoints
+    is enabled or not.
+    The default value is \c false.
+*/
 bool QSkeletonLoader::isCreateJointsEnabled() const
 {
     Q_D(const QSkeletonLoader);
     return d->m_createJoints;
 }
-
+/*!
+    Returns the root joint of the hierarchy of joints forming the skeleton.
+*/
 Qt3DCore::QJoint *QSkeletonLoader::rootJoint() const
 {
     Q_D(const QSkeletonLoader);
diff --git a/src/logic/qframeaction.cpp b/src/logic/qframeaction.cpp
index 37a00fc18..915fb015a 100644
--- a/src/logic/qframeaction.cpp
+++ b/src/logic/qframeaction.cpp
@@ -51,6 +51,11 @@ QFrameActionPrivate::QFrameActionPrivate()
 }
 
 /*!
+    \namespace Qt3DLogic::Logic
+
+    \brief Used to import and use the module's QML types.
+*/
+/*!
     \class Qt3DLogic::QFrameAction
     \inmodule Qt3DLogic
     \since 5.5
diff --git a/src/quick3d/quick3dscene2d/items/qscene2d.h b/src/quick3d/quick3dscene2d/items/qscene2d.h
index fd8466e22..c309fc831 100644
--- a/src/quick3d/quick3dscene2d/items/qscene2d.h
+++ b/src/quick3d/quick3dscene2d/items/qscene2d.h
@@ -51,6 +51,11 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+    \namespace Qt3DRender::Quick
+
+    \brief Internal namespace to import QML types.
+*/
 namespace Quick {
 
 class QScene2DPrivate;
diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp
index ccec826ff..f5c01dd75 100644
--- a/src/render/frontend/qrenderaspect.cpp
+++ b/src/render/frontend/qrenderaspect.cpp
@@ -180,6 +180,12 @@ namespace Qt3DRender {
  * \inmodule Qt3DRender
  */
 
+/*!
+    \namespace Qt3DRender::Render
+
+    \brief Namespace used for accessing the classes
+    Renderer and QRenderPlugin.
+*/
 /*! \internal */
 QRenderAspectPrivate::QRenderAspectPrivate(QRenderAspect::RenderType type)
     : QAbstractAspectPrivate()