diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-04-13 12:55:34 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-04-14 07:41:11 +0000 |
commit | f03dc3a2599a0f05cded8b984489b89113c7f037 (patch) | |
tree | 306902e9865550448dcf035ffa18c0be45834e62 /src/core/nodes | |
parent | 075c0298d1c75dd2d61849b559edcb357d638689 (diff) |
Doc: Fix multiple C++ documentation issues
- Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
is now able to collate namespace members from multiple modules.
- Mark 'Q...Private' classes and functions taking private arguments as
\internal
- Use correct \qtvariable for Qt 3D Core and Render
- Add src/plugins directory to Qt 3D Core documentation build to
correctly generate Assimp-related documentation.
- Ensure documentation for C++ properties is visible by
using the \property command instead of documenting the
setter/getter functions.
- Add export and logging macros to qdoc ignore directives
- Remove unnecessary use of \fn command
- Language and styling fixes
Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/core/nodes')
-rw-r--r-- | src/core/nodes/qbackendnode.cpp | 5 | ||||
-rw-r--r-- | src/core/nodes/qcomponent.cpp | 5 | ||||
-rw-r--r-- | src/core/nodes/qentity.cpp | 5 | ||||
-rw-r--r-- | src/core/nodes/qnode.cpp | 5 |
4 files changed, 20 insertions, 0 deletions
diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp index f1d926305..df7662f1f 100644 --- a/src/core/nodes/qbackendnode.cpp +++ b/src/core/nodes/qbackendnode.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QBackendNodePrivate + \internal +*/ QBackendNodePrivate::QBackendNodePrivate(QBackendNode *qq, QBackendNode::Mode mode) : q_ptr(qq) , m_mode(mode) @@ -123,6 +127,7 @@ QBackendNode *QBackendNode::createBackendNode(QNode *frontend) const return d->m_factory->createBackendNode(frontend); } +/*! \internal */ QBackendNode::QBackendNode(QBackendNodePrivate &dd) : d_ptr(&dd) { diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp index 2827db9f9..d3ed84c22 100644 --- a/src/core/nodes/qcomponent.cpp +++ b/src/core/nodes/qcomponent.cpp @@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QComponentPrivate + \internal +*/ QComponentPrivate::QComponentPrivate(QComponent *qq) : QNodePrivate(qq) , m_shareable(true) @@ -163,6 +167,7 @@ QVector<QEntity *> QComponent::entities() const return d->m_entities; } +/*! \internal */ QComponent::QComponent(QComponentPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/core/nodes/qentity.cpp b/src/core/nodes/qentity.cpp index 0e8c596d0..cd33fe442 100644 --- a/src/core/nodes/qentity.cpp +++ b/src/core/nodes/qentity.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QEntityPrivate + \internal +*/ QEntityPrivate::QEntityPrivate(QEntity *qq) : QNodePrivate(qq) , m_enabled(true) @@ -71,6 +75,7 @@ QEntity::~QEntity() removeAllComponents(); } +/*! \internal */ QEntity::QEntity(QEntityPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp index c9b780dd7..a7cbf96ce 100644 --- a/src/core/nodes/qnode.cpp +++ b/src/core/nodes/qnode.cpp @@ -54,6 +54,10 @@ namespace Qt3D { QHash<QNodeId, QNode *> QNodePrivate::m_clonesLookupTable = QHash<QNodeId, QNode *>(); +/*! + \class Qt3D::QNodePrivate + \internal +*/ QNodePrivate::QNodePrivate(QNode *qq) : QObjectPrivate() , m_changeArbiter(Q_NULLPTR) @@ -291,6 +295,7 @@ QNode::QNode(QNode *parent) // to add ourselve with the parent } +/*! \internal */ QNode::QNode(QNodePrivate &dd, QNode *parent) : QObject(dd, parent) { |