From 6eecb253c0a9a5d0c1eaaa031e38d24e3bb5f447 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antti=20M=C3=A4=C3=A4tt=C3=A4?= <antti.maatta@qt.io>
Date: Thu, 1 Sep 2016 12:48:22 +0300
Subject: Update QViewport docs

Change-Id: I9a81ddc741af8fb0f1126b431763ccf7a1f07e3a
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
---
 src/render/framegraph/qviewport.cpp | 54 ++++++++++++++++++++++---------------
 1 file changed, 32 insertions(+), 22 deletions(-)

diff --git a/src/render/framegraph/qviewport.cpp b/src/render/framegraph/qviewport.cpp
index c68ff141f..cf7667289 100644
--- a/src/render/framegraph/qviewport.cpp
+++ b/src/render/framegraph/qviewport.cpp
@@ -53,27 +53,39 @@ QViewportPrivate::QViewportPrivate()
 }
 
 /*!
- * \class Qt3DRender::QViewport
- * \inmodule Qt3DRender
- * \brief A viewport on the Qt3D Scene
- * \since 5.7
- *
- * \inherits Qt3DRender::QFrameGraphNode
- *
+    \class Qt3DRender::QViewport
+    \inmodule Qt3DRender
+    \brief A viewport on the Qt3D Scene
+    \since 5.7
+
+    \inherits Qt3DRender::QFrameGraphNode
+
+    Qt3DRender::QViewport of the scene specifies at which portion of the render surface Qt3D
+    is rendering to. Area outside the viewport is left untouched.
  */
 
 /*!
- * \qmltype Viewport
- * \inqmlmodule Qt3D.Render
- * \since 5.7
- * \ingroup
- * \instantiates Qt3DRender::QViewport
- * \brief A viewport on the Qt3D Scene
- *
+    \qmltype Viewport
+    \inqmlmodule Qt3D.Render
+    \since 5.7
+    \ingroup
+    \instantiates Qt3DRender::QViewport
+    \brief A viewport on the Qt3D Scene
+
+    Viewport of the scene specifies at which portion of the render surface Qt3D is
+    rendering to. Area outside the viewport is left untouched.
  */
 
 /*!
- * Constructs QViewport with given \a parent.
+    \qmlproperty rect Viewport::normalizedRect
+
+    Specifies the normalised rectangle for the viewport, i.e. the viewport rectangle
+    is specified relative to the render surface size. Whole surface sized viewport
+    is specified as [0.0, 0.0, 1.0, 1.0], which is the default.
+ */
+
+/*!
+    Constructs QViewport with given \a parent.
  */
 QViewport::QViewport(QNode *parent)
     : QFrameGraphNode(*new QViewportPrivate, parent)
@@ -99,14 +111,12 @@ QRectF QViewport::normalizedRect() const
 }
 
 /*!
-    \property Qt3DRender::QViewport::normalizedRect
-    Specifies the normalise rect for the viewport
-*/
-
-/*!
-  \qmlproperty QRectF Qt3D.Render::QViewport::normalizedRect
+    \property QViewport::normalizedRect
 
-*/
+    Specifies the normalised rectangle for the viewport, i.e. the viewport rectangle
+    is specified relative to the render surface size. Whole surface sized viewport
+    is specified as [0.0, 0.0, 1.0, 1.0], which is the default.
+ */
 void QViewport::setNormalizedRect(const QRectF &normalizedRect)
 {
     Q_D(QViewport);
-- 
cgit v1.2.3