more API docs

Also pull in the property name table (the up-to-dateness of which is
questionable).

The version number in the generated docs should be 2.0, not the
Qt version. Will need to figure out later how to maintain this.

Not everything is documented yet. Less important functions will get
covered later.

Many bits here and there are revised compared to the 1.1 docs.
There are however chunks that have been taken as-is. These need to be
cleaned up later on.

Most importantly, an initial Getting Started page has been added. This,
like the mobile/embedded page needs to be extended signficiantly later on.

A set of unused constructors (the ones taking no presentation) are
removed from Q3DSElement/SceneElement/DataInput. This is because
the QML API does not use them while it is impossible to utilize these
in a meaningful way from C++ (where are require setting the presentation
up-front with no setter afterwards).

There were a few qdoc warnings from the internal implementations due to
useless /*! or backslashes that confused qdoc. These are removed.

Task-number: QT3DS-1606
Change-Id: I141bdc774e5be3e4fed5c1d729cac9b68a02be3b
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

1 files changed, 51 insertions, 0 deletions

diff --git a/src/runtime/api/q3dsviewersettings.cpp b/src/runtime/api/q3dsviewersettings.cpp
index ba1249a..a0d91ea 100644
--- a/src/runtime/api/q3dsviewersettings.cpp
+++ b/src/runtime/api/q3dsviewersettings.cpp
@@ -32,6 +32,26 @@
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    \class Q3DSViewerSettings
+    \inmodule 3dstudioruntime2
+    \since Qt 3D Studio 2.0
+
+    \brief Qt 3D Studio presentation viewer settings.
+
+    Q3DSViewerSettings provides properties to define presentation independent
+    viewer settings.
+
+    \note As of Qt 3D Studio 2.0 this class is provided mainly for
+    compatibility reasons. Most functions are not applicable or are not
+    currently supported and will be silently ignored.
+
+    \note This class should not be instantiated directly when working with the
+    C++ APIs. Q3DSSurfaceViewer and Q3DSWidget create a Q3DSViewerSettings
+    instance implicitly. This can be queried via Q3DSSurfaceViewer::settings()
+    or Q3DSWidget::settings().
+ */
+
 Q3DSViewerSettings::Q3DSViewerSettings(QObject *parent)
     : QObject(*new Q3DSViewerSettingsPrivate, parent)
 {
@@ -52,6 +72,17 @@ QColor Q3DSViewerSettings::matteColor() const
     return d->matteColor;
 }
 
+/*!
+    \property Q3DSViewerSettings::showRenderStats
+
+    If this property is set to \c{true}, the interactive statistics and profile
+    view is displayed in-scene, on top of the 3D content.
+
+    \note This feature can be disabled at build time, in which case this
+    property has no effect.
+
+    Default value is \c{false}.
+*/
 bool Q3DSViewerSettings::isShowingRenderStats() const
 {
     Q_D(const Q3DSViewerSettings);
@@ -129,4 +160,24 @@ void Q3DSViewerSettings::load(const QString &group,
     qWarning() << Q_FUNC_INFO << "not implemented";
 }
 
+/*!
+    \qmltype ViewerSettings
+    \instantiates Q3DSViewerSettings
+    \inqmlmodule QtStudio3D
+    \ingroup 3dstudioruntime2
+    \brief Qt 3D Studio presentation viewer settings.
+
+    This type provides properties to define presentation independent viewer settings.
+
+    \sa Studio3D
+*/
+
+/*!
+    \qmlproperty bool ViewerSettings::showRenderStats
+
+    If this property is set to \c{true}, render statistics are displayed on the upper part
+    of the viewer.
+    Default value is \c{false}.
+*/
+
 QT_END_NAMESPACE