diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-02-08 15:40:03 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-02-16 11:34:41 +0000 |
| commit | 51dca6514593978beb28afa1c9f99ccd9a5c212c (patch) | |
| tree | 7345e172f91eabc902266c1863d670f9d30b2cfc /src/core/aspects | |
| parent | b5dc950424f601928f0e6032b1fd728e69f9fa98 (diff) | |
Doc: Fix documentation warnings for Qt 3D Core
This change fixes multiple QDoc warnings for Qt 3D Core that are
related to how Clang parses the source code and the \fn QDoc
commands.
We still have a number of 'No documentation for ...' warnings left -
those are not addressed in this change.
Change-Id: Ia6394f453d7bd959bc4d4cc9347ac0039b80f661
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/core/aspects')
| -rw-r--r-- | src/core/aspects/qabstractaspect.cpp | 8 | ||||
| -rw-r--r-- | src/core/aspects/qaspectengine.cpp | 2 | ||||
| -rw-r--r-- | src/core/aspects/qaspectmanager.cpp | 2 |
3 files changed, 4 insertions, 8 deletions
diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp index 2e37df60b..e793eebca 100644 --- a/src/core/aspects/qabstractaspect.cpp +++ b/src/core/aspects/qabstractaspect.cpp @@ -96,17 +96,11 @@ void QAbstractAspectPrivate::unregisterBackendType(const QMetaObject &mo) */ /*! - * \fn void QAbstractAspect::registerBackendType(const QBackendNodeMapperPtr &functor) + * \fn void Qt3DCore::QAbstractAspect::registerBackendType(const Qt3DCore::QBackendNodeMapperPtr &functor) * Registers backend with \a functor. */ /*! - * \internal - * \fn void registerBackendType(const QBackendNodeMapperPtr &functor) - * This is a workaround to fix an erroneous qdoc warning. KEEP IT INTERNAL - */ - -/*! * Constructs a new QAbstractAspect with \a parent */ QAbstractAspect::QAbstractAspect(QObject *parent) diff --git a/src/core/aspects/qaspectengine.cpp b/src/core/aspects/qaspectengine.cpp index 1467f0cff..b7a8c84b1 100644 --- a/src/core/aspects/qaspectengine.cpp +++ b/src/core/aspects/qaspectengine.cpp @@ -276,8 +276,8 @@ void QAspectEnginePrivate::exitSimulationLoop() /*! * Registers a new \a aspect to the AspectManager. The QAspectEngine takes * ownership of the aspect and will delete it when the aspect is unregistered. + //! Called in the main thread */ -// Called in the main thread void QAspectEngine::registerAspect(QAbstractAspect *aspect) { Q_D(QAspectEngine); diff --git a/src/core/aspects/qaspectmanager.cpp b/src/core/aspects/qaspectmanager.cpp index e2f0d9383..375a4ed83 100644 --- a/src/core/aspects/qaspectmanager.cpp +++ b/src/core/aspects/qaspectmanager.cpp @@ -198,6 +198,8 @@ void QAspectManager::setRootEntity(Qt3DCore::QEntity *root, const QVector<Qt3DCo } /*! + * \fn void Qt3DCore::QAspectManager::registerAspect(Qt3DCore::QAbstractAspect *aspect) + * * Registers a new \a aspect. */ void QAspectManager::registerAspect(QAbstractAspect *aspect) |