diff options
| author | Miikka Heikkinen <miikka.heikkinen@qt.io> | 2019-08-16 15:44:29 +0300 |
|---|---|---|
| committer | Miikka Heikkinen <miikka.heikkinen@qt.io> | 2019-08-19 10:45:38 +0300 |
| commit | ade751901f6d941cb9c25dc754051599e5fff40a (patch) | |
| tree | 444312dce950fe13ae57da019e42a05bd949754b | |
| parent | 7bd8ec0683b2bddded3872ce01be28e89089923f (diff) | |
Add docs for Q3DSSurfaceViewer::setQmlEngine/qmlEngine methods
Task-number: QT3DS-3563
Change-Id: Ia19a15b5ffe00e5de7aa8e96136d150b4fbb7b22
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
| -rw-r--r-- | src/api/studio3d/q3dssurfaceviewer.cpp | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/api/studio3d/q3dssurfaceviewer.cpp b/src/api/studio3d/q3dssurfaceviewer.cpp index a79597f..1ffad89 100644 --- a/src/api/studio3d/q3dssurfaceviewer.cpp +++ b/src/api/studio3d/q3dssurfaceviewer.cpp @@ -333,11 +333,10 @@ void Q3DSSurfaceViewer::setPresentationId(const QString &id) } } -// TODO: QT3DS-3563 - /*! - * \brief Q3DSSurfaceViewer::qmlEngine - * \return + * Returns the QML engine set with setQmlEngine method. + * + * \sa setQmlEngine */ QQmlEngine *Q3DSSurfaceViewer::qmlEngine() const { @@ -346,8 +345,11 @@ QQmlEngine *Q3DSSurfaceViewer::qmlEngine() const } /*! - * \brief Q3DSSurfaceViewer::setQmlEngine - * \param qmlEngine + * Sets the QML engine for rendering QML streams of the presentation to \a qmlEngine. + * The QML engine must be set before Q3DSSurfaceViewer::create is called. + * If the QML engine is not set, a new one will be created during runtime initialization. + * + * \sa qmlEngine */ void Q3DSSurfaceViewer::setQmlEngine(QQmlEngine *qmlEngine) { |