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/aspects | |
| 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/aspects')
| -rw-r--r-- | src/core/aspects/qabstractaspect.cpp | 5 | ||||
| -rw-r--r-- | src/core/aspects/qaspectengine.cpp | 5 | ||||
| -rw-r--r-- | src/core/aspects/qaspectfactory.cpp | 4 |
3 files changed, 14 insertions, 0 deletions
diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp index 1de4069e4..0330ccb8d 100644 --- a/src/core/aspects/qabstractaspect.cpp +++ b/src/core/aspects/qabstractaspect.cpp @@ -52,6 +52,10 @@ static QByteArray className(const QMetaObject &obj) namespace Qt3D { +/*! + \class Qt3D::QAbstractAspectPrivate + \internal +*/ QAbstractAspectPrivate::QAbstractAspectPrivate(QAbstractAspect *qq) : QObjectPrivate() , m_root(Q_NULLPTR) @@ -79,6 +83,7 @@ QAbstractAspect::QAbstractAspect(AspectType aspectType, QObject *parent) d->m_aspectType = aspectType; } +/*! \internal */ QAbstractAspect::QAbstractAspect(QAbstractAspectPrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/aspects/qaspectengine.cpp b/src/core/aspects/qaspectengine.cpp index 1c16c4bf4..82b06866a 100644 --- a/src/core/aspects/qaspectengine.cpp +++ b/src/core/aspects/qaspectengine.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAspectEnginePrivate + \internal +*/ QAspectEnginePrivate::QAspectEnginePrivate(QAspectEngine *qq) : QObjectPrivate() , m_postman(new QPostman()) @@ -81,6 +85,7 @@ QAspectEngine::QAspectEngine(QObject *parent) d->m_aspectThread->waitForStart(QThread::HighestPriority); } +/*! \internal */ QAspectEngine::QAspectEngine(QAspectEnginePrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/aspects/qaspectfactory.cpp b/src/core/aspects/qaspectfactory.cpp index 9c049c66c..04e902acf 100644 --- a/src/core/aspects/qaspectfactory.cpp +++ b/src/core/aspects/qaspectfactory.cpp @@ -54,6 +54,10 @@ QT3DCORESHARED_EXPORT void qt3d_QAspectFactoryPrivate_addDefaultFactory(const QS defaultFactories->insert(name, factory); } +/*! + \class Qt3D::QAspectFactoryPrivate + \internal +*/ QAspectFactoryPrivate::QAspectFactoryPrivate() : m_factories(*defaultFactories) { |