From b212e7a540ee3988964eb3612ad96c6687561cbc Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Thu, 26 Apr 2018 14:03:09 +0200 Subject: Doc: Add QT3D_REGISTER_ASPECT macro documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Also remove two '*' that ended up in the generated docs. Task-number: QTBUG-65413 Change-Id: Ia0870405f73166dbb73ee09e34e7625c51486b41 Reviewed-by: Topi Reiniö --- src/core/aspects/qabstractaspect.cpp | 20 ++++++++++++++++++++ src/core/aspects/qaspectengine.cpp | 4 ++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp index e793eebca..7b08dec81 100644 --- a/src/core/aspects/qabstractaspect.cpp +++ b/src/core/aspects/qabstractaspect.cpp @@ -100,6 +100,26 @@ void QAbstractAspectPrivate::unregisterBackendType(const QMetaObject &mo) * Registers backend with \a functor. */ +/*! + * \macro QT3D_REGISTER_ASPECT(name, AspectType) + * \relates Qt3DCore::QAbstractAspect + * + * Convenience macro for registering \a AspectType for instantiation by the + * currently set Qt3DCore::QAspectFactory. This makes it possible to create an + * instance of \a AspectType in the aspect thread by later passing \a name to + * Qt3DCore::QAspectEngine::registerAspect(const QString &name). + * + * \note It is also possible to register a new aspect without using this macro + * by instead using Qt3DCore::QAspectEngine::registerAspect(QAbstractAspect *aspect) + * which will handle moving a previously created aspect instance to the aspect + * thread context. + * + * KDAB has published a few articles about writing custom Qt3D aspects + * \l {https://www.kdab.com/writing-custom-qt-3d-aspect/}{on their blog}. These + * provide an excellent starting point if you wish to learn more about it. + */ + + /*! * Constructs a new QAbstractAspect with \a parent */ diff --git a/src/core/aspects/qaspectengine.cpp b/src/core/aspects/qaspectengine.cpp index b7a8c84b1..3f219597e 100644 --- a/src/core/aspects/qaspectengine.cpp +++ b/src/core/aspects/qaspectengine.cpp @@ -274,8 +274,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. + 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 */ void QAspectEngine::registerAspect(QAbstractAspect *aspect) -- cgit v1.2.3