From 4d4c7b617276446e87d05e97a1bcedb9e461d26d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antti=20M=C3=A4=C3=A4tt=C3=A4?= <antti.maatta@qt.io>
Date: Fri, 2 Sep 2016 12:33:50 +0300
Subject: Update QRenderSurfaceSelector docs

Change-Id: I8022413e6d6b7bcda469a7a5ec569f7af0cefd1f
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
---
 src/render/framegraph/qrendersurfaceselector.cpp | 92 +++++++++++++++---------
 1 file changed, 59 insertions(+), 33 deletions(-)

diff --git a/src/render/framegraph/qrendersurfaceselector.cpp b/src/render/framegraph/qrendersurfaceselector.cpp
index e76963e72..27d06e264 100644
--- a/src/render/framegraph/qrendersurfaceselector.cpp
+++ b/src/render/framegraph/qrendersurfaceselector.cpp
@@ -52,43 +52,70 @@ QT_BEGIN_NAMESPACE
 namespace Qt3DRender {
 
 /*!
- * \class Qt3DRender::QRenderSurfaceSelector
- * \inmodule Qt3DRender
- * \brief Provides a way of specifying the render surface
- * \since 5.7
- *
- * \inherits Qt3DRender::QFrameGraphNode
- *
+    \class Qt3DRender::QRenderSurfaceSelector
+    \inmodule Qt3DRender
+    \brief Provides a way of specifying the render surface
+    \since 5.7
+
+    The Qt3DRender::QRenderSurfaceSelector can be used to select the surface, where
+    Qt3D renders the content. The surface can either be window surface or offscreen
+    surface. The externalRenderTargetSize is used to specify the actual size of the
+    surface when offscreen surface is used.
+
+    When DPI scaling is used by the system, the logical surface size, which is used
+    by mouse events, and the actual 'physical' size of the surface can differ.
+    The surfacePixelRatio is the factor to convert the logical size to the physical
+    size.
+
+    \sa QWindow, QOffscreenSurface, QSurface
  */
 
 /*!
- * \qmltype RenderSurfaceSelector
- * \inqmlmodule Qt3D.Render
- * \since 5.7
- * \ingroup
- * \instantiates Qt3DRender::QRenderSurfaceSelector
- * \brief Provides a way of specifying the render surface
- *
+    \qmltype RenderSurfaceSelector
+    \inqmlmodule Qt3D.Render
+    \since 5.7
+    \instantiates Qt3DRender::QRenderSurfaceSelector
+    \inherits FrameGraphNode
+    \brief Provides a way of specifying the render surface
+
+    The RenderSurfaceSelector can be used to select the surface, where
+    Qt3D renders the content. The surface can either be window surface or offscreen
+    surface. The externalRenderTargetSize is used to specify the actual size of the
+    render target when offscreen surface is used.
+
+    When DPI scaling is used by the system, the logical surface size, which is used
+    by mouse events, and the actual 'physical' size of the surface can differ.
+    The surfacePixelRatio is the factor to convert the logical size to the physical
+    size.
  */
 
 /*! \qmlproperty QSurface Qt3D.Render::RenderSurfaceSelector::surface
- *
- * Holds the surface.
+    Holds the surface.
  */
 
-/*!
- *  \property QRenderSurfaceSelector::surface
- *  Holds the surface
+/*! \qmlproperty size Qt3D.Render::RenderSurfaceSelector::externalRenderTargetSize
+
+    Holds the size of the external render target.
+ */
+
+/*! \qmlproperty real Qt3D.Render::RenderSurfaceSelector::surfacePixelRatio
+
+    Holds the surfacePixelRatio of the surface.
  */
 
-/*! \qmlproperty QSize Qt3D.Render::RenderSurfaceSelector::externalRenderTargetSize
- *
- * Holds the size of the external render target.
+/*!
+     \property QRenderSurfaceSelector::surface
+     Holds the surface
  */
 
 /*!
- *  \property QRenderSurfaceSelector::externalRenderTargetSize
- *  Holds the size of the external render target.
+     \property QRenderSurfaceSelector::externalRenderTargetSize
+     Holds the size of the external render target.
+ */
+
+/*! \property QRenderSurfaceSelector::surfacePixelRatio
+
+    Holds the surfacePixelRatio of the surface.
  */
 
 QRenderSurfaceSelectorPrivate::QRenderSurfaceSelectorPrivate()
@@ -136,7 +163,7 @@ void QRenderSurfaceSelectorPrivate::setExternalRenderTargetSize(const QSize &siz
 }
 
 /*!
- * Constructs QRenderSurfaceSelector with given \a parent.
+    Constructs QRenderSurfaceSelector with given \a parent.
  */
 QRenderSurfaceSelector::QRenderSurfaceSelector(Qt3DCore::QNode *parent)
     : Qt3DRender::QFrameGraphNode(*new QRenderSurfaceSelectorPrivate, parent)
@@ -144,14 +171,14 @@ QRenderSurfaceSelector::QRenderSurfaceSelector(Qt3DCore::QNode *parent)
 }
 
 /*!
- * \internal
+    \internal
  */
 QRenderSurfaceSelector::~QRenderSurfaceSelector()
 {
 }
 
 /*!
- * \internal
+    \internal
  */
 QRenderSurfaceSelector::QRenderSurfaceSelector(QRenderSurfaceSelectorPrivate &dd, Qt3DCore::QNode *parent)
     : Qt3DRender::QFrameGraphNode(dd, parent)
@@ -178,9 +205,8 @@ QObject *QRenderSurfaceSelector::surface() const
     return surfaceObj;
 }
 
-/*! \property QRenderSurfaceSelector::surface
- *
- * Sets \a surface.
+/*!
+    Sets \a surfaceObject.
  */
 void QRenderSurfaceSelector::setSurface(QObject *surfaceObject)
 {
@@ -197,7 +223,7 @@ void QRenderSurfaceSelector::setSurface(QObject *surfaceObject)
                 surface = static_cast<QSurface *>(offscreen);
         }
 
-        Q_ASSERT_X(surface, Q_FUNC_INFO, "surfaceObject is not a valid QSurface * object");
+        Q_ASSERT_X(surface, Q_FUNC_INFO, "surfaceObject is not a valid QSurface    object");
     }
 
     if (d->m_surface == surface)
@@ -286,8 +312,8 @@ float QRenderSurfaceSelector::surfacePixelRatio() const
     return d->m_surfacePixelRatio;
 }
 /*!
- * Sets render target \a size if different than underlying surface size.
- * Tells picking the correct size.
+    Sets render target \a size if different than underlying surface size.
+    Tells picking the correct size.
  */
 void QRenderSurfaceSelector::setExternalRenderTargetSize(const QSize &size)
 {
-- 
cgit v1.2.3