diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-04-02 13:15:18 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2019-04-10 08:39:13 +0000 |
commit | ee4849ada20544b824452784a3a7893890e99e8e (patch) | |
tree | 8c7b173751099603c56cd7608fb0559aabca73e8 | |
parent | 2dfb43aceb1c8e9c9f2188f5f01798425e3bfbdd (diff) |
Doc: Fix documentation issues
This commit fixes multiple documentation warnings and problems:
- Add missing documentation for Presentation.
- Add missing 'QT += 3dstudioruntime2' class info by introducing
a \module page.
- Add missing import statements info for QML types by introducing
a \qmlmodule page.
- Make the documented QML import statements follow module
versioning.
- Add missing documentation dependencies.
- Omit internal classes/orphaned doc comments from the build.
- Fix minor language issues.
Change-Id: I854fc0646bfed9282c9a4159890b5fa6f40d46d0
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
27 files changed, 101 insertions, 68 deletions
diff --git a/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc b/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc index 46ed0f7..d30e55c 100644 --- a/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc +++ b/examples/3dstudioruntime2/layersinquick/doc/src/layersinquick.qdoc @@ -29,7 +29,7 @@ \example layersinquick \title Qt 3D Studio Runtime: Layers in Qt Quick Example \ingroup qt3dstudioruntime2-examples-qml - \brief Demonstrates using the View3D element in a Qt Quick application + \brief Demonstrates using the View3D element in a Qt Quick application. \image layersinquick.png diff --git a/examples/3dstudioruntime2/qmldatainput/doc/src/qmldatainput.qdoc b/examples/3dstudioruntime2/qmldatainput/doc/src/qmldatainput.qdoc index 58e6ae5..6a57cb4 100644 --- a/examples/3dstudioruntime2/qmldatainput/doc/src/qmldatainput.qdoc +++ b/examples/3dstudioruntime2/qmldatainput/doc/src/qmldatainput.qdoc @@ -29,7 +29,7 @@ \example qmldatainput \title Qt 3D Studio Runtime: QML DataInput Example \ingroup qt3dstudioruntime2-examples-qml - \brief Demonstrates using DataInput elements in QML + \brief Demonstrates using DataInput elements in QML. \image qmldatainput.png diff --git a/examples/3dstudioruntime2/scenemanip/doc/src/scenemanip.qdoc b/examples/3dstudioruntime2/scenemanip/doc/src/scenemanip.qdoc index 871c57d..1acc47e 100644 --- a/examples/3dstudioruntime2/scenemanip/doc/src/scenemanip.qdoc +++ b/examples/3dstudioruntime2/scenemanip/doc/src/scenemanip.qdoc @@ -29,7 +29,7 @@ \example scenemanip \title Qt 3D Studio Runtime: Dynamic Scene Manipulation C++ Example \ingroup qt3dstudioruntime2-examples-cpp - \brief Demonstrates using the private C++ APIs to change the scene at run time + \brief Demonstrates using the private C++ APIs to change the scene at run time. \image scenemanip.png diff --git a/examples/3dstudioruntime2/simpleoffscreen/doc/src/simpleoffscreen.qdoc b/examples/3dstudioruntime2/simpleoffscreen/doc/src/simpleoffscreen.qdoc index ecc0da8..18c6bba 100644 --- a/examples/3dstudioruntime2/simpleoffscreen/doc/src/simpleoffscreen.qdoc +++ b/examples/3dstudioruntime2/simpleoffscreen/doc/src/simpleoffscreen.qdoc @@ -29,7 +29,7 @@ \example simpleoffscreen \title Qt 3D Studio Runtime: Simple Offscreen Example \ingroup qt3dstudioruntime2-examples-cpp - \brief Demonstrates using the Q3DSSurfaceViewer class render frames into image files + \brief Demonstrates using the Q3DSSurfaceViewer class render frames into image files. \image simpleoffscreen.png diff --git a/examples/3dstudioruntime2/simpleqml/doc/src/simpleqml.qdoc b/examples/3dstudioruntime2/simpleqml/doc/src/simpleqml.qdoc index dfd0f16..f4cb2d6 100644 --- a/examples/3dstudioruntime2/simpleqml/doc/src/simpleqml.qdoc +++ b/examples/3dstudioruntime2/simpleqml/doc/src/simpleqml.qdoc @@ -29,7 +29,7 @@ \example simpleqml \title Qt 3D Studio Runtime: Simple QML Example \ingroup qt3dstudioruntime2-examples-qml - \brief Demonstrates using the Studio3D element in a Qt Quick application + \brief Demonstrates using the Studio3D element in a Qt Quick application. \image simpleqml.png diff --git a/examples/3dstudioruntime2/simplewidget/doc/src/simplewidget.qdoc b/examples/3dstudioruntime2/simplewidget/doc/src/simplewidget.qdoc index ab02d59..c5db375 100644 --- a/examples/3dstudioruntime2/simplewidget/doc/src/simplewidget.qdoc +++ b/examples/3dstudioruntime2/simplewidget/doc/src/simplewidget.qdoc @@ -29,7 +29,7 @@ \example simplewidget \title Qt 3D Studio Runtime: Simple Widget Example \ingroup qt3dstudioruntime2-examples-cpp - \brief Demonstrates using the Q3DSWidget widget in a Qt C++ application + \brief Demonstrates using the Q3DSWidget widget in a Qt C++ application. \image simplewidget.png diff --git a/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc b/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc index b00bc3e..3b72e02 100644 --- a/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc +++ b/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc @@ -29,7 +29,7 @@ \example simplewindow \title Qt 3D Studio Runtime: Simple Window Example \ingroup qt3dstudioruntime2-examples-cpp - \brief Demonstrates using the Q3DSSurfaceViewer class in order to render in a QWindow + \brief Demonstrates using the Q3DSSurfaceViewer class in order to render in a QWindow. \image simplewindow.png diff --git a/examples/3dstudioruntime2/stereoscopicqml/doc/src/stereoscopicqml.qdoc b/examples/3dstudioruntime2/stereoscopicqml/doc/src/stereoscopicqml.qdoc index 4fc7c22..3ac6336 100644 --- a/examples/3dstudioruntime2/stereoscopicqml/doc/src/stereoscopicqml.qdoc +++ b/examples/3dstudioruntime2/stereoscopicqml/doc/src/stereoscopicqml.qdoc @@ -29,7 +29,7 @@ \example stereoscopicqml \title Qt 3D Studio Runtime: Stereoscopic QML Example \ingroup qt3dstudioruntime2-examples-qml - \brief Demonstrates using the stereoscopic QML API of Studio3D ViewerSettings + \brief Demonstrates using the stereoscopic QML API of Studio3D ViewerSettings. \image stereoscopicqml.png diff --git a/src/runtime/api/q3dsdatainput.cpp b/src/runtime/api/q3dsdatainput.cpp index d70f4ca..ec92e74 100644 --- a/src/runtime/api/q3dsdatainput.cpp +++ b/src/runtime/api/q3dsdatainput.cpp @@ -35,7 +35,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSDataInput - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Controls a data input entry in a Qt 3D Studio presentation. @@ -126,8 +126,8 @@ QVariant Q3DSDataInput::value() const /*! Returns true if presentation (or its subpresentation) associated with - this datainput has a datainput definition with a matching name. Returns - false if the datainput has no associated presentation, or if a match is not found. + this data input has a data input definition with a matching name. Returns + false if the data input has no associated presentation, or if a match is not found. */ bool Q3DSDataInput::isValid() const { @@ -142,9 +142,9 @@ bool Q3DSDataInput::isValid() const } /*! - Returns the metadata for this datainput for the specified \a key. Metadata is convenience - data that can be used by API clients to better identify datainput purpose, and facilitate - binding the appropriate external data source to this datainput. Metadata does not have + Returns the metadata for this data input for the specified \a key. Metadata is convenience + data that can be used by API clients to better identify data input purpose, and facilitate + binding the appropriate external data source to this data input. Metadata does not have any impact to rendering. \sa Q3DSDataInput::metadataKeys() @@ -160,7 +160,7 @@ QVariant Q3DSDataInput::metadata(const QVariant &key) const } /*! - Returns the metadata keys for this datainput. + Returns the metadata keys for this data input. \sa Q3DSDataInput::metadata() @@ -176,7 +176,7 @@ QVariantList Q3DSDataInput::metadataKeys() const } /*! - Removes the metadata for this datainput for the specified \a key. + Removes the metadata for this data input for the specified \a key. \sa Q3DSDataInput::metadata() */ @@ -187,7 +187,7 @@ void Q3DSDataInput::removeMetadata(const QVariant &key) } /*! - Sets the \a metadata for this datainput for the specified \a key. + Sets the \a metadata for this data input for the specified \a key. \sa Q3DSDataInput::metadata() */ @@ -214,8 +214,8 @@ void Q3DSDataInput::setValue(const QVariant &value) /*! \property Q3DSDataInput::min - Returns the minimum range value for datainput. Returned value is zero - for datainput types other than \e {Ranged Number}. + Returns the minimum range value for data input. Returned value is zero + for data input types other than \e {Ranged Number}. */ float Q3DSDataInput::min() const { @@ -227,7 +227,7 @@ float Q3DSDataInput::min() const } /*! - Sets the minimum range for datainput. + Sets the minimum (\a min) range value for data input. This property is applicable only to data input type \e {Ranged Number}. */ @@ -241,8 +241,8 @@ void Q3DSDataInput::setMin(float min) /*! \property Q3DSDataInput::max - Returns the maximum range value for datainput. Returned value is zero - for datainput types other than \e {Ranged Number}. + Returns the maximum (\a max) range value for data input. Returned value is zero + for data input types other than \e {Ranged Number}. */ float Q3DSDataInput::max() const { @@ -255,7 +255,7 @@ float Q3DSDataInput::max() const } /*! - Sets the maximum range value for datainput. + Sets the maximum (\a max) range value for data input. This property is applicable only to data input type \e {Ranged Number}. */ @@ -420,25 +420,25 @@ void Q3DSDataInputPrivate::sendMetadataRemove(const QVariant &key) /*! \qmlmethod void DataInput::setMetadata(QVariant key, QVariant metadata) - Sets the datainput \a metadata for \a key. + Sets the data input \a metadata for \a key. */ /*! \qmlmethod QVariant DataInput::getMetadata(QVariant key) - Gets the datainput metadata for \a key. + Gets the data input metadata for \a key. */ /*! \qmlmethod QVariantList DataInput::getMetadataKeys() - Gets all metadata keys for this datainput. + Gets all metadata keys for this data input. */ /*! \qmlmethod void DataInput::removeMetadata(QVariant key) - Removes datainput metadata for /a key. + Removes data input metadata for /a key. */ QT_END_NAMESPACE diff --git a/src/runtime/api/q3dselement.cpp b/src/runtime/api/q3dselement.cpp index ba99c80..0ac7f28 100644 --- a/src/runtime/api/q3dselement.cpp +++ b/src/runtime/api/q3dselement.cpp @@ -34,7 +34,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSElement - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Controls a scene object (node) in a Qt 3D Studio presentation. diff --git a/src/runtime/api/q3dspresentation.cpp b/src/runtime/api/q3dspresentation.cpp index 0e5ad47..17518e7 100644 --- a/src/runtime/api/q3dspresentation.cpp +++ b/src/runtime/api/q3dspresentation.cpp @@ -36,7 +36,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSPresentation - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Represents a Qt 3D Studio presentation. @@ -137,6 +137,7 @@ void Q3DSPresentation::setSource(const QUrl &source) /*! \property Q3DSPresentation::variantList +//! [presentation-variantlist] Holds a list of (variant group):(variant) tags that are loaded when the \c{source} property is set. If this list is left empty (default), no variant filtering is applied and all items are loaded regardless of variant tags in @@ -164,6 +165,7 @@ void Q3DSPresentation::setSource(const QUrl &source) \endlist If the item doesn't fulfill the above rules it will not be loaded. +//! [presentation-variantlist] */ QStringList Q3DSPresentation::variantList() const { @@ -438,8 +440,10 @@ void Q3DSPresentation::setDelayedLoading(bool enable) } /*! - Preloads slide resources to memory. All resources required by the given slide will be - loaded in the background. This function has effect only when delayed loading is enabled. + Preloads slide resources to memory. The \a elementPath specifies the time context + (a Scene or a Component element) owning the slide. All resources required by the given + slide will be loaded in the background. This function has an effect only when delayed + loading is enabled. */ void Q3DSPresentation::preloadSlide(const QString &elementPath) { @@ -449,8 +453,10 @@ void Q3DSPresentation::preloadSlide(const QString &elementPath) } /*! - Unloads slide resources from memory. If the slide is current, then the resources are unloaded - when the slide is changed. This function has effect only when delayed loading is enabled. + Unloads slide resources from memory. The \a elementPath specifies the time context + (a Scene or a Component element) owning the slide. If the slide is current, then the + resources are unloaded when the slide is changed. This function has an effect only when + delayed loading is enabled. */ void Q3DSPresentation::unloadSlide(const QString &elementPath) { @@ -517,6 +523,11 @@ void Q3DSPresentation::setAttribute(const QString &elementPath, const QString &a d->controller->handleSetAttribute(elementPath, attributeName, value); } +/*! + Returns a list of data inputs defined for this presentation as a QVariantList. + + \sa dataInputs() +*/ QVariantList Q3DSPresentation::getDataInputs() { QVariantList ret; @@ -528,9 +539,9 @@ QVariantList Q3DSPresentation::getDataInputs() } /*! - Returns a list of datainputs defined for this presentation. Use setDataInputValue() - interface to set a datainput value using datainput name, or call Q3DSDataInput::setValue - directly for a specific datainput. + Returns a list of data inputs defined for this presentation. Use setDataInputValue() + interface to set a data input value by name, or call Q3DSDataInput::setValue() + directly on a specific data input. \sa setDataInputValue \sa Q3DSDataInput @@ -560,7 +571,7 @@ QVector<Q3DSDataInput *> Q3DSPresentation::dataInputs() } } /*! - Returns a list of datainputs defined for this presentation which have metadata key + Returns a list of data inputs defined for this presentation which have metadata key \a metadataKey. \sa Q3DSDataInput @@ -981,6 +992,11 @@ void Q3DSPresentationPrivate::removeDatainputMetadata(const QString &name, const */ /*! + \qmlproperty list<string> Presentation::variantList + \include q3dspresentation.cpp presentation-variantlist +*/ + +/*! \qmlmethod void Presentation::goToSlide(string elementPath, string name) Requests a time context (a Scene or a Component node) to change to a specific slide @@ -1118,6 +1134,14 @@ void Q3DSPresentationPrivate::removeDatainputMetadata(const QString &name, const */ /*! + \qmlmethod var Presentation::getDataInputs() + + Returns a list of data inputs defined for this presentation as an array. + + \sa setDataInputValue() +*/ + +/*! \qmlsignal Presentation::customSignalEmitted(string elementPath, string name) This signal is emitted when an action with the \c{Emit Signal} diff --git a/src/runtime/api/q3dssceneelement.cpp b/src/runtime/api/q3dssceneelement.cpp index cb7482b..6ddb761 100644 --- a/src/runtime/api/q3dssceneelement.cpp +++ b/src/runtime/api/q3dssceneelement.cpp @@ -35,7 +35,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSSceneElement \inherits Q3DSElement - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Controls the special Scene or Component scene objects in a Qt 3D diff --git a/src/runtime/api/q3dssurfaceviewer.cpp b/src/runtime/api/q3dssurfaceviewer.cpp index a0ecad6..6bf2170 100644 --- a/src/runtime/api/q3dssurfaceviewer.cpp +++ b/src/runtime/api/q3dssurfaceviewer.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSSurfaceViewer - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Renders a Qt 3D Studio presentation on a QWindow or an offscreen diff --git a/src/runtime/api/q3dsviewersettings.cpp b/src/runtime/api/q3dsviewersettings.cpp index 22297e9..0267f6f 100644 --- a/src/runtime/api/q3dsviewersettings.cpp +++ b/src/runtime/api/q3dsviewersettings.cpp @@ -34,7 +34,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSViewerSettings - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \brief Qt 3D Studio presentation viewer settings. diff --git a/src/runtime/api/q3dswidget.cpp b/src/runtime/api/q3dswidget.cpp index 4700615..508dfd5 100644 --- a/src/runtime/api/q3dswidget.cpp +++ b/src/runtime/api/q3dswidget.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! \class Q3DSWidget - \inmodule 3dstudioruntime2 + \inmodule Qt3DStudioRuntime2 \since Qt 3D Studio 2.0 \inherits QOpenGLWidget diff --git a/src/runtime/aping/q3dsgroup3d.cpp b/src/runtime/aping/q3dsgroup3d.cpp index 76d45a3..894ef93 100644 --- a/src/runtime/aping/q3dsgroup3d.cpp +++ b/src/runtime/aping/q3dsgroup3d.cpp @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Group3D - \instantiates Q3DSGroup3D + //! \instantiates Q3DSGroup3D \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 \inherits Node3D diff --git a/src/runtime/aping/q3dslayer3d.cpp b/src/runtime/aping/q3dslayer3d.cpp index 50f9eb4..4210f60 100644 --- a/src/runtime/aping/q3dslayer3d.cpp +++ b/src/runtime/aping/q3dslayer3d.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Layer3D - \instantiates Q3DSLayer3D + //! \instantiates Q3DSLayer3D \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 \inherits Item @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \internal - \brief An item rendering the contents of a single Qt 3D Studio layer + \brief An item rendering the contents of a single Qt 3D Studio layer. */ class Q3DSLayerTextureProvider : public QSGTextureProvider diff --git a/src/runtime/aping/q3dsnode3d.cpp b/src/runtime/aping/q3dsnode3d.cpp index 001189c..2d740ef 100644 --- a/src/runtime/aping/q3dsnode3d.cpp +++ b/src/runtime/aping/q3dsnode3d.cpp @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Node3D - \instantiates Q3DSNode3D + //! \instantiates Q3DSNode3D \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 \inherits Object3D diff --git a/src/runtime/aping/q3dsobject3d.cpp b/src/runtime/aping/q3dsobject3d.cpp index 1798869..206a090 100644 --- a/src/runtime/aping/q3dsobject3d.cpp +++ b/src/runtime/aping/q3dsobject3d.cpp @@ -34,7 +34,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Object3D - \instantiates Q3DSObject3D + //! \instantiates Q3DSObject3D \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 \inherits Object diff --git a/src/runtime/aping/q3dsstudio3dengine.cpp b/src/runtime/aping/q3dsstudio3dengine.cpp index 245e23d..bb68a53 100644 --- a/src/runtime/aping/q3dsstudio3dengine.cpp +++ b/src/runtime/aping/q3dsstudio3dengine.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Studio3DEngine - \instantiates Q3DSImGuiItem + //! \instantiates Q3DSImGuiItem \inqmlmodule Q3DSStudio3DEngine \ingroup 3dstudioruntime2 \inherits Item @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE \internal - \brief A non-visual item representing a Qt 3D Studio + Qt 3D engine + \brief A non-visual item representing a Qt 3D Studio + Qt 3D engine. Unlike \c Scene3D or \l Studio3D where the output of the 3D renderer is shown in a single rectangular area, more advanced 3D integration approaches diff --git a/src/runtime/behaviorapi/q3dsbehaviorobject.cpp b/src/runtime/behaviorapi/q3dsbehaviorobject.cpp index f8a740f..dddea7b 100644 --- a/src/runtime/behaviorapi/q3dsbehaviorobject.cpp +++ b/src/runtime/behaviorapi/q3dsbehaviorobject.cpp @@ -299,7 +299,7 @@ QVector3D Q3DSBehaviorObject::lookAt(const QVector3D &target) \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 - \brief Technology Preview Behavior Integration + \brief Technology Preview Behavior Integration. This is a technology preview (API may change in upcoming version) of how Qt 3D Studio could support writing custom behavior scripts using QML and @@ -312,8 +312,8 @@ QVector3D Q3DSBehaviorObject::lookAt(const QVector3D &target) application code. In QML behavior script, the integration to Qt 3D Studio is established by using - the metadata tag system similar to the \l {file-formats-effects.html}{effect} - and \l {file-formats-material.html}{material} files. + the metadata tag system similar to \l {Custom Materials and Effects} + {effect and material files}. \badcode [[ diff --git a/src/runtime/doc/qt3d-runtime-project.qdocconf b/src/runtime/doc/qt3d-runtime-project.qdocconf index 5affbcc..beef5e9 100644 --- a/src/runtime/doc/qt3d-runtime-project.qdocconf +++ b/src/runtime/doc/qt3d-runtime-project.qdocconf @@ -17,10 +17,10 @@ headerdirs += ../../imports/studio3d sourcedirs += ../behaviorapi headerdirs += ../behaviorapi -depends = qtcore qtgui qtwidgets qtqml qtquick qtquickcontrols2 qt3dstudio qtdoc qt3d +depends = qtcore qtgui qtwidgets qtqml qtquick qtquickcontrols qt3dstudio qtdoc qt3d qmake # TODO: remove these once they're no longer needed -depends += qt3dcore qt3drender qt3dlogic qt3danimation +depends += qt3dcore qt3drender qt3dlogic qt3danimation qtquickcontrols2 qhp.projects = Qt3DStudioRuntime2 @@ -65,3 +65,4 @@ examplesinstallpath = 3dstudioruntime2 exampledirs += ../../../examples/3dstudioruntime2 Cpp.ignoretokens += Q3DSV_EXPORT +macro.Q3DSVer = "$QT_VER" diff --git a/src/runtime/doc/src/module.qdoc b/src/runtime/doc/src/module.qdoc index e37139c..cf9ea87 100644 --- a/src/runtime/doc/src/module.qdoc +++ b/src/runtime/doc/src/module.qdoc @@ -26,6 +26,17 @@ ****************************************************************************/ /*! + \module Qt3DStudioRuntime2 + \noautolist + \qtvariable 3dstudioruntime2 +*/ + +/*! + \qmlmodule QtStudio3D \Q3DSVer + \noautolist +*/ + +/*! \page qt3d-runtime-cpp.html \title Qt 3D Studio Runtime C++ Classes \keyword C++ API @@ -36,7 +47,7 @@ To include the definitions of the module's classes, use the following directive: - \badcode + \code #include <Qt3DStudioRuntime2> \endcode @@ -78,7 +89,7 @@ \section1 Classes - \generatelist {classesbymodule 3dstudioruntime2} + \generatelist {classesbymodule Qt3DStudioRuntime2} */ /*! @@ -86,8 +97,6 @@ \title Qt 3D Studio Runtime QML Types \keyword QML API \ingroup qmlmodules - \noautolist - \brief QML Types for the Qt 3D Studio Runtime module. The Qt 3D Studio Runtime provides a number of QML types to integrate and @@ -95,9 +104,9 @@ can be imported into your application using the following import statement in your \c{.qml} file: - \badcode - import QtStudio3D 2.1 - \endcode + \qml \Q3DSVer + import QtStudio3D \1 + \endqml The main type for embedding a Qt 3D Studio presentations into a Qt Quick scene is \l Studio3D. Many of the other types correspond to a C++ class in diff --git a/src/runtime/doc/src/scenecppapi.qdoc b/src/runtime/doc/src/scenecppapi.qdoc index 4c0b622..0d93261 100644 --- a/src/runtime/doc/src/scenecppapi.qdoc +++ b/src/runtime/doc/src/scenecppapi.qdoc @@ -29,7 +29,7 @@ \page qt3d-runtime-scenecppapi.html \title Advanced Scene Manipulation via the Qt 3D Studio Runtime Private C++ Classes - In addition to the \l {Qt 3D Studio Runtime C++ Classes}}{public C++ API}, + In addition to the \l {Qt 3D Studio Runtime C++ Classes}{public C++ API}, applications needing direct access to the scenegraph of the presentations loaded from \c{.uip} files can use the runtime's private C++ classes. diff --git a/src/runtime/dragon/dragonrenderer.cpp b/src/runtime/dragon/dragonrenderer.cpp index 2fef519..9381b33 100644 --- a/src/runtime/dragon/dragonrenderer.cpp +++ b/src/runtime/dragon/dragonrenderer.cpp @@ -80,7 +80,7 @@ GraphicsApiFilterData contextInfo(const QOpenGLContext &m_gl) return m_contextInfo; } -/*! +/* \brief Renderer lives on a separate thread performs the actual rendering of the RenderCommands from each RenderView. @@ -128,7 +128,7 @@ Renderer::~Renderer() m_shareContext->deleteLater(); } -/*! +/* * \internal * \brief Renderer::initialize * @@ -183,7 +183,7 @@ void Renderer::addLatestData(FrameInput data) m_latestData.enqueue(data); } -/*! +/* * \brief Renderer::contextInfo * * Blocks until doRender has gotten context info for us. diff --git a/src/runtime/dragon/renderstates/dragonrenderstatecreatedchange.cpp b/src/runtime/dragon/renderstates/dragonrenderstatecreatedchange.cpp index cc0f4e6..614a7d1 100644 --- a/src/runtime/dragon/renderstates/dragonrenderstatecreatedchange.cpp +++ b/src/runtime/dragon/renderstates/dragonrenderstatecreatedchange.cpp @@ -59,7 +59,7 @@ RenderStateCreatedChangeBase::RenderStateCreatedChangeBase(const Qt3DRender::QRe { } -/*! +/* * \return the current render state type */ Dragon::StateMask RenderStateCreatedChangeBase::renderStateType() const diff --git a/src/runtime/profileui/q3dsimguiitem.cpp b/src/runtime/profileui/q3dsimguiitem.cpp index 0dec9a2..1c71917 100644 --- a/src/runtime/profileui/q3dsimguiitem.cpp +++ b/src/runtime/profileui/q3dsimguiitem.cpp @@ -45,14 +45,13 @@ QT_BEGIN_NAMESPACE /*! \qmltype Studio3DProfiler - \instantiates Q3DSImGuiItem + //! \instantiates Q3DSImGuiItem \inqmlmodule QtStudio3D \ingroup 3dstudioruntime2 \inherits Item - \keyword Studio3DProfiler \since Qt 3D Studio 2.2 - \brief An item rendering profile and debug views in Qt Quick + \brief An item rendering profile and debug views in Qt Quick. Studio3DProfiler displays the \l{Using the In-Scene Debug and Profile views}{debug and profiling views} via Qt Quick. This approach can be more |