diff options
author | Colin Ogilvie <colin.ogilvie@kdab.com> | 2016-05-26 16:46:28 +0100 |
---|---|---|
committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2016-06-03 06:28:40 +0000 |
commit | f55baa3a1c1b768f5010ebecda5589b3885ced27 (patch) | |
tree | 56ea4be4b8c87c9ac0d034a1d280b7eff8d344ab /src/core/changes/qnodedestroyedchange.cpp | |
parent | d2ab8f2d4c24bf44218ec1e4b5fb34f548b000eb (diff) |
Doc for core module
Task-number: QTBUG-46037
Change-Id: I187794f67a61e3e626e7992b0cfe211811823466
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/core/changes/qnodedestroyedchange.cpp')
-rw-r--r-- | src/core/changes/qnodedestroyedchange.cpp | 21 |
1 files changed, 21 insertions, 0 deletions
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); |