summaryrefslogtreecommitdiffstats
path: root/src/qmlstreamer
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2019-06-13 12:41:11 +0300
committerMats Honkamaa <mats.honkamaa@qt.io>2019-06-19 16:15:32 +0300
commitc31b28180b8bd0c1cbcbad7874b653d31ce2d920 (patch)
tree253e81bcfd35acb586c8fb2c64ff5ce724ff5134 /src/qmlstreamer
parent899724924e71ed7e13e5698dec9ade21ba8d40e4 (diff)
Initial OpenGL runtime documentation structure
Copied from Qt3D runtime docs with some modifications. Task-number: QT3DS-3561 Change-Id: I67fc9bc59290b34e788cf4a79676c9e04e634979 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Pasi Keränen <pasi.keranen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/qmlstreamer')
-rw-r--r--src/qmlstreamer/q3dsqmlstream.cpp9
-rw-r--r--src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp8
2 files changed, 7 insertions, 10 deletions
diff --git a/src/qmlstreamer/q3dsqmlstream.cpp b/src/qmlstreamer/q3dsqmlstream.cpp
index e1b9e85..c0dc6a2 100644
--- a/src/qmlstreamer/q3dsqmlstream.cpp
+++ b/src/qmlstreamer/q3dsqmlstream.cpp
@@ -32,7 +32,7 @@
/*!
\qmltype QmlStream
\instantiates Q3DSQmlStream
- \inqmlmodule Qt3DStudio
+ \inqmlmodule QtStudio3D.OpenGL
\ingroup OpenGLRuntime
\brief Allows streaming of QML as subpresentation.
@@ -43,12 +43,10 @@
\inmodule OpenGLRuntime
\since Qt 3D Studio 2.0
\brief Allows streaming of QML as subpresentation.
- \param parent
*/
/*!
- * \brief Q3DSQmlStream::Q3DSQmlStream Constructor
- * \param parent Optional parent object.
+ Constructs a Q3DSQmlStream object with \a parent as parent.
*/
Q3DSQmlStream::Q3DSQmlStream(QObject *parent)
: QObject(parent)
@@ -56,9 +54,6 @@ Q3DSQmlStream::Q3DSQmlStream(QObject *parent)
{
}
-/*!
- * \brief Q3DSQmlStream::~Q3DSQmlStream Destructor.
- */
Q3DSQmlStream::~Q3DSQmlStream()
{
}
diff --git a/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp b/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp
index bde5ad3..664b9e4 100644
--- a/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp
+++ b/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp
@@ -33,9 +33,9 @@
/*!
\qmltype SubPresentationSettings
\instantiates Q3DSSubPresentationSettings
- \inqmlmodule Qt3DStudio
+ \inqmlmodule QtStudio3D.OpenGL
\ingroup OpenGLRuntime
- \brief
+ \brief Settings for subpresentations.
\sa Studio3D, Presentation, QmlStream
*/
@@ -44,7 +44,6 @@
\inmodule OpenGLRuntime
\since Qt 3D Studio 2.0
\brief Settings for subpresentations.
- \param parent
\sa Q3DSPresentation, Q3DSQmlStream
*/
@@ -71,6 +70,9 @@ QQmlListProperty<Q3DSQmlStream> Q3DSSubPresentationSettings::qmlStreams()
return QQmlListProperty<Q3DSQmlStream>(this, m_list);
}
+/*!
+ Returns the list of QML streams to be used as subpresentations.
+*/
QList<Q3DSQmlStream *> Q3DSSubPresentationSettings::qmlStreamsList()
{
return m_list;