summaryrefslogtreecommitdiffstats
path: root/src/core/nodes
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2018-10-24 15:06:58 +0200
committerNico Vertriest <nico.vertriest@qt.io>2018-11-01 08:35:00 +0000
commit7b401dcd3345d42108eb162ea354f64152c9d0a4 (patch)
treee9bc776eb1bfdf9e342c7bd92d77bebe2415f4a2 /src/core/nodes
parentacae8420e94d90a60096cf46c04f461ad134246c (diff)
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>
Diffstat (limited to 'src/core/nodes')
-rw-r--r--src/core/nodes/qbackendnode.cpp8
-rw-r--r--src/core/nodes/qcomponent.cpp11
2 files changed, 19 insertions, 0 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.