diff options
author | Mika Salmela <mika.salmela@theqtcompany.com> | 2016-01-27 13:37:45 +0200 |
---|---|---|
committer | Mika Salmela <mika.salmela@theqtcompany.com> | 2016-01-27 11:40:34 +0000 |
commit | 910065ad7585cbef7f49356de0c1434c791a9263 (patch) | |
tree | ad2db952a702e4d10a36606aa81a97f0568f8ce5 | |
parent | 5a68874f7a2f18070890bec7c3259af94abe320b (diff) |
Documentation for QQmlAspectEngine
Change-Id: I656d9d5e6ed5fe2420e2b2ced8193040dfce666f
Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
-rw-r--r-- | src/quick3d/quick3d/qqmlaspectengine.cpp | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/src/quick3d/quick3d/qqmlaspectengine.cpp b/src/quick3d/quick3d/qqmlaspectengine.cpp index f8f7bffa6..a425e9cb9 100644 --- a/src/quick3d/quick3d/qqmlaspectengine.cpp +++ b/src/quick3d/quick3d/qqmlaspectengine.cpp @@ -45,6 +45,13 @@ QT_BEGIN_NAMESPACE namespace Qt3DCore { namespace Quick { +/*! + \namespace Qt3DCore::Quick + \inmodule Qt3DCore + \brief Contains classes used for implementing QML functionality into Qt3D + applications. +*/ + QQmlAspectEnginePrivate::QQmlAspectEnginePrivate() : QObjectPrivate() , m_qmlEngine(new QQmlEngine()) @@ -53,11 +60,42 @@ QQmlAspectEnginePrivate::QQmlAspectEnginePrivate() { } +/*! + * \class Qt3DCore::Quick::QQmlAspectEngine + * \inmodule Qt3DCore + * + * \brief The QQmlAspectEngine provides an environment for the QAspectEngine and + * a method for instantiating QML components. + */ + +/*! + * \enum Qt3DCore::Quick::QQmlAspectEngine::Status + * + * The status of the engine. + * + * \value Null + * \value Ready + * \value Loading + * \value Error + */ + +/*! + * \fn void Qt3DCore::Quick::QQmlAspectEngine::statusChanged(Status status) + * + * This signal is emitted with \a status when the status of the engine changes. + */ + +/*! + * Constructs a new QQmlAspectEngine with \a parent. + */ QQmlAspectEngine::QQmlAspectEngine(QObject *parent) : QObject(*new QQmlAspectEnginePrivate, parent) { } +/*! + * \return the status. + */ QQmlAspectEngine::Status QQmlAspectEngine::status() const { Q_D(const QQmlAspectEngine); @@ -68,6 +106,9 @@ QQmlAspectEngine::Status QQmlAspectEngine::status() const return Status(d->m_component->status()); } +/*! + * Sets \a source as a source for the QML component to be created. + */ void QQmlAspectEngine::setSource(const QUrl &source) { Q_D(QQmlAspectEngine); @@ -88,12 +129,18 @@ void QQmlAspectEngine::setSource(const QUrl &source) } } +/*! + * \return the engine. + */ QQmlEngine *QQmlAspectEngine::qmlEngine() const { Q_D(const QQmlAspectEngine); return d->m_qmlEngine.data(); } +/*! + * \return the aspectEngine. + */ QAspectEngine *QQmlAspectEngine::aspectEngine() const { Q_D(const QQmlAspectEngine); |