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/transforms | |
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/transforms')
-rw-r--r-- | src/core/transforms/qabstracttransform.cpp | 6 | ||||
-rw-r--r-- | src/core/transforms/qlookattransform.cpp | 5 | ||||
-rw-r--r-- | src/core/transforms/qmatrixtransform.cpp | 4 | ||||
-rw-r--r-- | src/core/transforms/qrotatetransform.cpp | 5 | ||||
-rw-r--r-- | src/core/transforms/qscaletransform.cpp | 5 | ||||
-rw-r--r-- | src/core/transforms/qtransform.cpp | 5 | ||||
-rw-r--r-- | src/core/transforms/qtranslatetransform.cpp | 5 |
7 files changed, 34 insertions, 1 deletions
diff --git a/src/core/transforms/qabstracttransform.cpp b/src/core/transforms/qabstracttransform.cpp index aa40902b5..2a4d97ff4 100644 --- a/src/core/transforms/qabstracttransform.cpp +++ b/src/core/transforms/qabstracttransform.cpp @@ -41,17 +41,21 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractTransformPrivate + \internal +*/ QAbstractTransformPrivate::QAbstractTransformPrivate() : QObjectPrivate() { } - QAbstractTransform::QAbstractTransform(QObject *parent) : QObject(*new QAbstractTransformPrivate, parent) { } +/*! \internal */ QAbstractTransform::QAbstractTransform(QAbstractTransformPrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/transforms/qlookattransform.cpp b/src/core/transforms/qlookattransform.cpp index ce042e229..cea39ac81 100644 --- a/src/core/transforms/qlookattransform.cpp +++ b/src/core/transforms/qlookattransform.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QLookAtTransformPrivate + \internal +*/ QLookAtTransformPrivate::QLookAtTransformPrivate() : QAbstractTransformPrivate() , m_matrixDirty(true) @@ -53,6 +57,7 @@ QLookAtTransform::QLookAtTransform(QObject *parent) { } +/*! \internal */ QLookAtTransform::QLookAtTransform(QLookAtTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qmatrixtransform.cpp b/src/core/transforms/qmatrixtransform.cpp index a85812457..706a183f1 100644 --- a/src/core/transforms/qmatrixtransform.cpp +++ b/src/core/transforms/qmatrixtransform.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QMatrixTransformPrivate + \internal +*/ QMatrixTransformPrivate::QMatrixTransformPrivate() : QAbstractTransformPrivate() { diff --git a/src/core/transforms/qrotatetransform.cpp b/src/core/transforms/qrotatetransform.cpp index b20168f9a..264b0b5bc 100644 --- a/src/core/transforms/qrotatetransform.cpp +++ b/src/core/transforms/qrotatetransform.cpp @@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRotateTransformPrivate + \internal +*/ QRotateTransformPrivate::QRotateTransformPrivate() : QAbstractTransformPrivate() , m_angleDeg(0) @@ -69,6 +73,7 @@ QRotateTransform::QRotateTransform(QObject *parent) { } +/*! \internal */ QRotateTransform::QRotateTransform(QRotateTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qscaletransform.cpp b/src/core/transforms/qscaletransform.cpp index 82e7ad19e..f102fe373 100644 --- a/src/core/transforms/qscaletransform.cpp +++ b/src/core/transforms/qscaletransform.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QScaleTransformPrivate + \internal +*/ QScaleTransformPrivate::QScaleTransformPrivate() : QAbstractTransformPrivate() , m_scale3D(1.0f, 1.0f, 1.0f) @@ -54,6 +58,7 @@ QScaleTransform::QScaleTransform(QObject *parent) { } +/*! \internal */ QScaleTransform::QScaleTransform(QScaleTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qtransform.cpp b/src/core/transforms/qtransform.cpp index 83107041e..5ec3fe6c0 100644 --- a/src/core/transforms/qtransform.cpp +++ b/src/core/transforms/qtransform.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTransformPrivate + \internal +*/ QTransformPrivate::QTransformPrivate(QTransform *qq) : QComponentPrivate(qq), m_transformsDirty(false) @@ -93,6 +97,7 @@ QTransform::QTransform(QAbstractTransform *transform, QNode *parent) addTransform(transform); } +/*! \internal */ QTransform::QTransform(QTransformPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/core/transforms/qtranslatetransform.cpp b/src/core/transforms/qtranslatetransform.cpp index 54f9cf997..6c7dc0896 100644 --- a/src/core/transforms/qtranslatetransform.cpp +++ b/src/core/transforms/qtranslatetransform.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTranslateTransformPrivate + \internal +*/ QTranslateTransformPrivate::QTranslateTransformPrivate() : QAbstractTransformPrivate() { @@ -53,6 +57,7 @@ QTranslateTransform::QTranslateTransform(QObject *parent) { } +/*! \internal */ QTranslateTransform::QTranslateTransform(QTranslateTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { |