The rest of the doc for render-framegraph

Task-number: QTBUG-46037
Change-Id: I611fac7c701b921f46c8cda0ad1ede3612db0844
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

9 files changed, 145 insertions, 12 deletions

diff --git a/src/render/framegraph/qdispatchcompute.cpp b/src/render/framegraph/qdispatchcompute.cpp
index edec231e3..abb4d7bdb 100644
--- a/src/render/framegraph/qdispatchcompute.cpp
+++ b/src/render/framegraph/qdispatchcompute.cpp
@@ -49,7 +49,7 @@ namespace Qt3DRender {
   \since 5.7
   \ingroup framegraph
 
-  \brief ...
+  \brief Allows a glDispatchCompute call to be issued to do work in a compute shader on the GPU.
 
  */
 
@@ -59,7 +59,7 @@ namespace Qt3DRender {
     \instantiates Qt3DRender::QDispatchCompute
     \inherits FrameGraphNode
     \since 5.7
-    \qmlabstract
+    \qmlabstract Allows a glDispatchCompute call to be issued to do work in a compute shader on the GPU.
 */
 
 /*!
diff --git a/src/render/framegraph/qfrustumculling.cpp b/src/render/framegraph/qfrustumculling.cpp
index b25c271d5..5ba96926e 100644
--- a/src/render/framegraph/qfrustumculling.cpp
+++ b/src/render/framegraph/qfrustumculling.cpp
@@ -48,8 +48,9 @@ namespace Qt3DRender {
   \since 5.7
   \ingroup framegraph
 
-  \brief ...
-
+  \brief If present, only tries to draw entities that are in the view of the camera.
+    The camera is selected by a QCameraSelector frame graph node in the current hierarchy.
+    \sa QCameraSelector
  */
 
 /*!
@@ -58,7 +59,9 @@ namespace Qt3DRender {
     \instantiates Qt3DRender::QFrustumCulling
     \inherits FrameGraphNode
     \since 5.7
-    \qmlabstract
+    \qmlabstract If present, only tries to draw entities that are in the view of the camera.
+    The camera is selected by a CameraSelector frame graph node in the current hierarchy
+    \sa CameraSelector
 */
 
 /*!
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index e2f3675b9..7f595b4c7 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -57,7 +57,9 @@ QLayerFilterPrivate::QLayerFilterPrivate()
     \class Qt3DRender::QLayerFilter
     \inmodule Qt3DRender
     \since 5.5
-    \brief The QLayerFilter class provides ...
+    \brief Controls layers Drawn in a frame graph branch.
+
+    A QLayerFiler can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph.
 */
 
 /*!
@@ -66,7 +68,9 @@ QLayerFilterPrivate::QLayerFilterPrivate()
     \inherits FrameGraphNode
     \inqmlmodule Qt3D.Render
     \since 5.5
-    \brief For ...
+    \brief Controls layers Drawn in a frame graph branch.
+
+    A QLayerFiler can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph.
 */
 
 
diff --git a/src/render/framegraph/qrenderpassfilter.cpp b/src/render/framegraph/qrenderpassfilter.cpp
index d014a6dbf..0adc5a48a 100644
--- a/src/render/framegraph/qrenderpassfilter.cpp
+++ b/src/render/framegraph/qrenderpassfilter.cpp
@@ -56,7 +56,7 @@ namespace Qt3DRender {
     \class Qt3DRender::QRenderPassFilter
     \inmodule Qt3DRender
     \since 5.7
-    \brief The QRenderPassFilter class provides storage for vectors of Filter Keys and Parameters
+    \brief Provides storage for vectors of Filter Keys and Parameters
 */
 
 /*!
diff --git a/src/render/framegraph/qrendersurfaceselector.cpp b/src/render/framegraph/qrendersurfaceselector.cpp
index cef183b5a..a5f0d2fdb 100644
--- a/src/render/framegraph/qrendersurfaceselector.cpp
+++ b/src/render/framegraph/qrendersurfaceselector.cpp
@@ -52,8 +52,8 @@ namespace Qt3DRender {
 /*!
  * \class Qt3DRender::QRenderSurfaceSelector
  * \inmodule Qt3DRender
- * \brief QRenderSurfaceSelector
- * \since
+ * \brief Provides a way of specifying the render surface
+ * \since 5.7
  *
  * \inherits Qt3DRender::QFrameGraphNode
  *
@@ -62,10 +62,10 @@ namespace Qt3DRender {
 /*!
  * \qmltype RenderSurfaceSelector
  * \inqmlmodule Qt3D.Render
- * \since
+ * \since 5.7
  * \ingroup
  * \instantiates Qt3DRender::QRenderSurfaceSelector
- * \brief RenderSurfaceSelector
+ * \brief Provides a way of specifying the render surface
  *
  */
 
diff --git a/src/render/framegraph/qrendertargetselector.cpp b/src/render/framegraph/qrendertargetselector.cpp
index ca5743a57..a413bbf56 100644
--- a/src/render/framegraph/qrendertargetselector.cpp
+++ b/src/render/framegraph/qrendertargetselector.cpp
@@ -48,6 +48,25 @@ QT_BEGIN_NAMESPACE
 using namespace Qt3DCore;
 
 namespace Qt3DRender {
+/*!
+ * \class Qt3DRender::QRenderTargetSelector
+ * \inmodule Qt3DRender
+ * \brief Provides a way of specifying a render target
+ * \since 5.7
+ *
+ * \inherits Qt3DRender::QFrameGraphNode
+ *
+ */
+
+/*!
+ * \qmltype RenderTargetSelector
+ * \inqmlmodule Qt3D.Render
+ * \since 5.7
+ * \ingroup
+ * \instantiates Qt3DRender::QRenderTargetSelector
+ * \brief RenderTargetSelector
+ *
+ */
 
 QRenderTargetSelectorPrivate::QRenderTargetSelectorPrivate()
     : QFrameGraphNodePrivate()
@@ -55,6 +74,9 @@ QRenderTargetSelectorPrivate::QRenderTargetSelectorPrivate()
 {
 }
 
+/*!
+ * Constructs QRenderTargetSelector with given \a parent.
+ */
 QRenderTargetSelector::QRenderTargetSelector(QNode *parent)
     : QFrameGraphNode(*new QRenderTargetSelectorPrivate, parent)
 {
@@ -65,6 +87,15 @@ QRenderTargetSelector::~QRenderTargetSelector()
 {
 }
 
+/*!
+ *  \property QRenderTargetSelector::target
+ *  Specifies the target to be rendered
+ */
+
+/*! \qmlproperty QWindow Qt3D.Render::RenderTargetSelector::target
+ *
+ * the target to be rendered
+ */
 void QRenderTargetSelector::setTarget(QRenderTarget *target)
 {
     Q_D(QRenderTargetSelector);
@@ -127,6 +158,7 @@ QVector<QRenderTargetOutput::AttachmentPoint> QRenderTargetSelector::outputs() c
     return d->m_outputs;
 }
 
+/*! \internal */
 QRenderTargetSelector::QRenderTargetSelector(QRenderTargetSelectorPrivate &dd, QNode *parent)
     : QFrameGraphNode(dd, parent)
 {
diff --git a/src/render/framegraph/qsortpolicy.cpp b/src/render/framegraph/qsortpolicy.cpp
index fbbff6541..8f047f452 100644
--- a/src/render/framegraph/qsortpolicy.cpp
+++ b/src/render/framegraph/qsortpolicy.cpp
@@ -52,6 +52,29 @@ QSortPolicyPrivate::QSortPolicyPrivate()
 {
 }
 
+/*!
+ * \class Qt3DRender::QSortPolicy
+ * \inmodule Qt3DRender
+ * \brief Provides storage for the sort types to be used
+ * \since 5.7
+ *
+ * \inherits Qt3DRender::QFrameGraphNode
+ *
+ */
+
+/*!
+ * \qmltype SortPolicy
+ * \inqmlmodule Qt3D.Render
+ * \since 5.7
+ * \ingroup
+ * \instantiates Qt3DRender::QSortPolicy
+ * \brief Provides storage for the sort types to be used
+ *
+ */
+
+/*!
+ * Constructs QSortPolicy with given \a parent.
+ */
 QSortPolicy::QSortPolicy(QNode *parent)
     : QFrameGraphNode(*new QSortPolicyPrivate, parent)
 {
@@ -77,6 +100,16 @@ QNodeCreatedChangeBasePtr QSortPolicy::createNodeCreationChange() const
     return creationChange;
 }
 
+/*!
+    \property Qt3DRender::QViewport::sortTypes
+    Specifies the sorting types to be used.
+*/
+
+/*!
+  \qmlproperty QVariantList Qt3D.Render::QSortPolicy::sortTypes
+    Specifies the sorting types to be used.
+
+*/
 QVector<QSortPolicy::SortType> QSortPolicy::sortTypes() const
 {
     Q_D(const QSortPolicy);
diff --git a/src/render/framegraph/qtechniquefilter.cpp b/src/render/framegraph/qtechniquefilter.cpp
index 07707866c..f63784888 100644
--- a/src/render/framegraph/qtechniquefilter.cpp
+++ b/src/render/framegraph/qtechniquefilter.cpp
@@ -56,6 +56,16 @@ QTechniqueFilterPrivate::QTechniqueFilterPrivate()
 {
 }
 
+/*!
+    \class Qt3DRender::QTechniqueFilter
+    \inmodule Qt3DRender
+    \since 5.7
+    \brief Provides storage for vectors of Filter Keys and Parameters
+*/
+
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QTechniqueFilter::QTechniqueFilter(QNode *parent)
     : QFrameGraphNode(*new QTechniqueFilterPrivate, parent)
 {
@@ -72,12 +82,18 @@ QTechniqueFilter::QTechniqueFilter(QTechniqueFilterPrivate &dd, QNode *parent)
 {
 }
 
+/*!
+  Returns a vector of the current keys for the filter.
+ */
 QVector<QFilterKey *> QTechniqueFilter::matchAll() const
 {
     Q_D(const QTechniqueFilter);
     return d->m_matchList;
 }
 
+/*!
+  Add the filter key /a filterKey to the match vector.
+ */
 void QTechniqueFilter::addMatch(QFilterKey *filterKey)
 {
     Q_ASSERT(filterKey);
@@ -103,6 +119,9 @@ void QTechniqueFilter::addMatch(QFilterKey *filterKey)
     }
 }
 
+/*!
+  Remove the filter key /a filterKey from the match vector.
+ */
 void QTechniqueFilter::removeMatch(QFilterKey *filterKey)
 {
     Q_ASSERT(filterKey);
@@ -117,6 +136,9 @@ void QTechniqueFilter::removeMatch(QFilterKey *filterKey)
     d->unregisterDestructionHelper(filterKey);
 }
 
+/*!
+  Add the parameter /a parameter to the parameter vector.
+ */
 void QTechniqueFilter::addParameter(QParameter *parameter)
 {
     Q_ASSERT(parameter);
@@ -142,6 +164,9 @@ void QTechniqueFilter::addParameter(QParameter *parameter)
     }
 }
 
+/*!
+  Remove the parameter /a parameter from the parameter vector.
+ */
 void QTechniqueFilter::removeParameter(QParameter *parameter)
 {
     Q_ASSERT(parameter);
@@ -156,6 +181,9 @@ void QTechniqueFilter::removeParameter(QParameter *parameter)
     d->unregisterDestructionHelper(parameter);
 }
 
+/*!
+  Returns the current vector of parameters.
+ */
 QVector<QParameter *> QTechniqueFilter::parameters() const
 {
     Q_D(const QTechniqueFilter);
diff --git a/src/render/framegraph/qviewport.cpp b/src/render/framegraph/qviewport.cpp
index cdbe7efb5..c68ff141f 100644
--- a/src/render/framegraph/qviewport.cpp
+++ b/src/render/framegraph/qviewport.cpp
@@ -52,6 +52,29 @@ QViewportPrivate::QViewportPrivate()
 {
 }
 
+/*!
+ * \class Qt3DRender::QViewport
+ * \inmodule Qt3DRender
+ * \brief A viewport on the Qt3D Scene
+ * \since 5.7
+ *
+ * \inherits Qt3DRender::QFrameGraphNode
+ *
+ */
+
+/*!
+ * \qmltype Viewport
+ * \inqmlmodule Qt3D.Render
+ * \since 5.7
+ * \ingroup
+ * \instantiates Qt3DRender::QViewport
+ * \brief A viewport on the Qt3D Scene
+ *
+ */
+
+/*!
+ * Constructs QViewport with given \a parent.
+ */
 QViewport::QViewport(QNode *parent)
     : QFrameGraphNode(*new QViewportPrivate, parent)
 {
@@ -68,12 +91,22 @@ QViewport::QViewport(QViewportPrivate &dd, QNode *parent)
 {
 }
 
+
 QRectF QViewport::normalizedRect() const
 {
     Q_D(const QViewport);
     return d->m_normalizedRect;
 }
 
+/*!
+    \property Qt3DRender::QViewport::normalizedRect
+    Specifies the normalise rect for the viewport
+*/
+
+/*!
+  \qmlproperty QRectF Qt3D.Render::QViewport::normalizedRect
+
+*/
 void QViewport::setNormalizedRect(const QRectF &normalizedRect)
 {
     Q_D(QViewport);