From 556fa62d1fa03ad0e216d12c9ffdeec81b55bfa8 Mon Sep 17 00:00:00 2001
From: Laszlo Agocs <laszlo.agocs@qt.io>
Date: Tue, 22 May 2018 10:24:00 +0200
Subject: doc: finish up the C++ docs

Change-Id: I26abc856bba4c150b918e1800a2eb34b44bc9f81
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
---
 src/runtime/api/q3dssurfaceviewer.cpp | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'src/runtime/api/q3dssurfaceviewer.cpp')

diff --git a/src/runtime/api/q3dssurfaceviewer.cpp b/src/runtime/api/q3dssurfaceviewer.cpp
index 8ecb6c3..bbe6344 100644
--- a/src/runtime/api/q3dssurfaceviewer.cpp
+++ b/src/runtime/api/q3dssurfaceviewer.cpp
@@ -176,6 +176,11 @@ bool Q3DSSurfaceViewerPrivate::doCreate(QSurface *s, QOpenGLContext *c, uint id,
     return createEngine();
 }
 
+/*!
+    Releases the presentation and all related resources.
+
+    The Q3DSSurfaceViewer instance can be reused by calling create() again.
+ */
 void Q3DSSurfaceViewer::destroy()
 {
     Q_D(Q3DSSurfaceViewer);
@@ -187,6 +192,19 @@ void Q3DSSurfaceViewer::destroy()
     d->fbo = 0;
 }
 
+/*!
+    \fn Q3DSSurfaceViewer::frameUpdate()
+
+    This signal is emitted each time a frame has been rendered.
+*/
+
+/*!
+    \fn Q3DSSurfaceViewer::presentationLoaded()
+
+    This signal is emitted when the viewer has been initialized and the
+    presentation is ready to be shown.
+*/
+
 /*!
     Returns the presentation object used by the Q3DSSurfaceViewer.
 */
@@ -205,6 +223,15 @@ Q3DSViewerSettings *Q3DSSurfaceViewer::settings() const
     return d->viewerSettings;
 }
 
+/*!
+    \property Q3DSSurfaceViewer::error
+
+    Contains the text for the error message that was generated during the
+    loading of the presentation. When no error occurred or there is no
+    presentation loaded, the value is an empty string.
+
+    This property is read-only.
+ */
 QString Q3DSSurfaceViewer::error() const
 {
     Q_D(const Q3DSSurfaceViewer);
@@ -225,6 +252,14 @@ bool Q3DSSurfaceViewer::isRunning() const
     return d->engine && d->sourceLoaded;
 }
 
+/*!
+    \property Q3DSSurfaceViewer::size
+
+    Holds the desired size of the presentation. Relevant only when
+    autoSize is set to \c false.
+
+    \sa autoSize
+*/
 QSize Q3DSSurfaceViewer::size() const
 {
     Q_D(const Q3DSSurfaceViewer);
-- 
cgit v1.2.3