Start on skeleton doc for render-framegraph

Task-number: QTBUG-46037
Change-Id: Ided34e5a0aed66bd67e8aef7af6689a31a09dc29
Reviewed-by: Mike Krus <mike.krus@kdab.com>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

7 files changed, 182 insertions, 6 deletions

diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp
index 7e76141f9..a9188cd99 100644
--- a/src/render/framegraph/qcameraselector.cpp
+++ b/src/render/framegraph/qcameraselector.cpp
@@ -48,8 +48,22 @@ QT_BEGIN_NAMESPACE
 namespace Qt3DRender {
 
 /*!
-    \class Qt3DRender::QCameraSelector
-    \inmodule Qt3DRender
+  \class Qt3DRender::QCameraSelector
+  \inmodule Qt3DRender
+  \since 5.5
+  \ingroup framegraph
+
+  \brief Class to allow for selection of camera to be used
+
+ */
+
+/*!
+    \qmltype CameraSelector
+    \inqmlmodule Qt3D.Render
+    \instantiates Qt3DRender::QCameraSelector
+    \inherits FrameGraphNode
+    \since 5.5
+    \qmlabstract
 */
 
 /*! \internal */
@@ -64,6 +78,9 @@ QCameraSelectorPrivate::QCameraSelectorPrivate()
 {
 }
 
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QCameraSelector::QCameraSelector(Qt3DCore::QNode *parent)
     :   QFrameGraphNode(*new QCameraSelectorPrivate, parent)
 {
@@ -77,6 +94,11 @@ QCameraSelector::~QCameraSelector()
 /*!
     \property Qt3DRender::QCameraSelector::camera
 */
+
+/*!
+  \qmlproperty Entity Qt3D.Render::CameraSelector::camera
+
+*/
 void QCameraSelector::setCamera(Qt3DCore::QEntity *camera)
 {
     Q_D(QCameraSelector);
diff --git a/src/render/framegraph/qclearbuffers.cpp b/src/render/framegraph/qclearbuffers.cpp
index 48068e290..4d8b872e4 100644
--- a/src/render/framegraph/qclearbuffers.cpp
+++ b/src/render/framegraph/qclearbuffers.cpp
@@ -44,6 +44,23 @@
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
+/*!
+  \class Qt3DRender::QClearBuffers
+  \inmodule Qt3DRender
+  \since 5.7
+  \ingroup framegraph
+
+  \brief Class to clear buffers
+ */
+
+/*!
+    \qmltype ClearBuffers
+    \inqmlmodule Qt3D.Render
+    \instantiates Qt3DRender::QClearBuffers
+    \inherits FrameGraphNode
+    \since 5.7
+    \qmlabstract
+*/
 
 QClearBuffersPrivate::QClearBuffersPrivate()
     : QFrameGraphNodePrivate()
@@ -54,6 +71,9 @@ QClearBuffersPrivate::QClearBuffersPrivate()
 {
 }
 
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QClearBuffers::QClearBuffers(QNode *parent)
     : QFrameGraphNode(*new QClearBuffersPrivate, parent)
 {
@@ -101,6 +121,15 @@ QRenderTargetOutput *QClearBuffers::colorBuffer() const
     return d->m_buffer;
 }
 
+/*!
+    \property Qt3DRender::QClearBuffers::buffers
+    Specifies the buffer type to be used.
+ */
+
+/*!
+  \qmlproperty BufferType Qt3D.Render::ClearBuffers::buffers
+
+*/
 void QClearBuffers::setBuffers(QClearBuffers::BufferType buffers)
 {
     Q_D(QClearBuffers);
@@ -110,6 +139,14 @@ void QClearBuffers::setBuffers(QClearBuffers::BufferType buffers)
     }
 }
 
+/*!
+    \property Qt3DRender::QClearBuffers::clearColor
+    Specifies the clear color to be used.
+ */
+/*!
+  \qmlproperty Color Qt3D.Render::ClearBuffers::color
+
+*/
 void QClearBuffers::setClearColor(const QColor &color)
 {
     Q_D(QClearBuffers);
@@ -119,6 +156,15 @@ void QClearBuffers::setClearColor(const QColor &color)
     }
 }
 
+
+/*!
+    \property Qt3DRender::QClearBuffers::clearDepthValue
+    Specifies the clear depth value to be used.
+ */
+/*!
+  \qmlproperty float Qt3D.Render::ClearBuffers::clearDepthValue
+
+*/
 void QClearBuffers::setClearDepthValue(float clearDepthValue)
 {
     Q_D(QClearBuffers);
@@ -130,6 +176,15 @@ void QClearBuffers::setClearDepthValue(float clearDepthValue)
     }
 }
 
+
+/*!
+    \property Qt3DRender::QClearBuffers::clearStencilValue
+    Specifies the stencil value to be used.
+ */
+/*!
+  \qmlproperty int Qt3D.Render::ClearBuffers::clearStencilValue
+
+*/
 void QClearBuffers::setClearStencilValue(int clearStencilValue)
 {
     Q_D(QClearBuffers);
@@ -144,6 +199,10 @@ void QClearBuffers::setClearStencilValue(int clearStencilValue)
     Specifies a specific color buffer to clear. If set to NULL (default), and
     ColorBuffer flag is set, all color buffers will be cleared.
  */
+/*!
+  \qmlproperty Qt3D.Render::RenderTargetOutput Qt3D.Render::ClearBuffers::colorbuffer
+
+*/
 void QClearBuffers::setColorBuffer(QRenderTargetOutput *buffer)
 {
     Q_D(QClearBuffers);
diff --git a/src/render/framegraph/qdispatchcompute.cpp b/src/render/framegraph/qdispatchcompute.cpp
index 0d3796c71..edec231e3 100644
--- a/src/render/framegraph/qdispatchcompute.cpp
+++ b/src/render/framegraph/qdispatchcompute.cpp
@@ -43,7 +43,28 @@
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
-
+/*!
+  \class Qt3DRender::QDispatchCompute
+  \inmodule Qt3DRender
+  \since 5.7
+  \ingroup framegraph
+
+  \brief ...
+
+ */
+
+/*!
+    \qmltype DispatchCompute
+    \inqmlmodule Qt3D.Render
+    \instantiates Qt3DRender::QDispatchCompute
+    \inherits FrameGraphNode
+    \since 5.7
+    \qmlabstract
+*/
+
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QDispatchCompute::QDispatchCompute(Qt3DCore::QNode *parent)
     : QFrameGraphNode(*new QDispatchComputePrivate(), parent)
 {
@@ -72,6 +93,10 @@ int QDispatchCompute::workGroupZ() const
     return d->m_workGroupZ;
 }
 
+/*!
+    \property Qt3DRender::QDispatchCompute::workGroupX
+    Specifies X workgroup.
+ */
 void QDispatchCompute::setWorkGroupX(int workGroupX)
 {
     Q_D(QDispatchCompute);
@@ -81,6 +106,10 @@ void QDispatchCompute::setWorkGroupX(int workGroupX)
     }
 }
 
+/*!
+    \property Qt3DRender::QDispatchCompute::workGroupY
+    Specifies Y workgroup.
+ */
 void QDispatchCompute::setWorkGroupY(int workGroupY)
 {
     Q_D(QDispatchCompute);
@@ -90,6 +119,10 @@ void QDispatchCompute::setWorkGroupY(int workGroupY)
     }
 }
 
+/*!
+    \property Qt3DRender::QDispatchCompute::workGroupZ
+    Specifies Z workgroup.
+ */
 void QDispatchCompute::setWorkGroupZ(int workGroupZ)
 {
     Q_D(QDispatchCompute);
diff --git a/src/render/framegraph/qfrustumculling.cpp b/src/render/framegraph/qfrustumculling.cpp
index ded5aa8a8..b25c271d5 100644
--- a/src/render/framegraph/qfrustumculling.cpp
+++ b/src/render/framegraph/qfrustumculling.cpp
@@ -42,7 +42,28 @@
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
+/*!
+  \class Qt3DRender::QFrustumCulling
+  \inmodule Qt3DRender
+  \since 5.7
+  \ingroup framegraph
 
+  \brief ...
+
+ */
+
+/*!
+    \qmltype FrustumCulling
+    \inqmlmodule Qt3D.Render
+    \instantiates Qt3DRender::QFrustumCulling
+    \inherits FrameGraphNode
+    \since 5.7
+    \qmlabstract
+*/
+
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QFrustumCulling::QFrustumCulling(Qt3DCore::QNode *parent)
     : QFrameGraphNode(parent)
 {
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index 7900d5fba..e2f3675b9 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -69,8 +69,9 @@ QLayerFilterPrivate::QLayerFilterPrivate()
     \brief For ...
 */
 
-/*! \fn Qt3DRender::QLayerFilter::QLayerFilter(Qt3DCore::QNode *parent)
-  Constructs a new QLayerFilter with the specified \a parent.
+
+/*!
+  The constructor creates an instance with the specified \a parent.
  */
 QLayerFilter::QLayerFilter(QNode *parent)
     : QFrameGraphNode(*new QLayerFilterPrivate, parent)
diff --git a/src/render/framegraph/qnodraw.cpp b/src/render/framegraph/qnodraw.cpp
index 1f9d44717..21634d1cb 100644
--- a/src/render/framegraph/qnodraw.cpp
+++ b/src/render/framegraph/qnodraw.cpp
@@ -59,6 +59,19 @@ namespace Qt3DRender {
  * \since 5.5
  */
 
+/*!
+    \qmltype NoDraw
+    \instantiates Qt3DRender::QNoDraw
+    \inherits FrameGraphNode
+    \inqmlmodule Qt3D.Render
+    \since 5.5
+    \brief When a NoDraw node is present in a FrameGraph branch, this
+ * prevents the renderer from rendering any primitive.
+*/
+
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QNoDraw::QNoDraw(QNode *parent)
     : QFrameGraphNode(parent)
 {
diff --git a/src/render/framegraph/qrenderpassfilter.cpp b/src/render/framegraph/qrenderpassfilter.cpp
index 21f90a998..d014a6dbf 100644
--- a/src/render/framegraph/qrenderpassfilter.cpp
+++ b/src/render/framegraph/qrenderpassfilter.cpp
@@ -52,7 +52,16 @@ using namespace Qt3DCore;
 
 namespace Qt3DRender {
 
-
+/*!
+    \class Qt3DRender::QRenderPassFilter
+    \inmodule Qt3DRender
+    \since 5.7
+    \brief The QRenderPassFilter class provides storage for vectors of Filter Keys and Parameters
+*/
+
+/*!
+  The constructor creates an instance with the specified \a parent.
+ */
 QRenderPassFilter::QRenderPassFilter(QNode *parent)
     : QFrameGraphNode(*new QRenderPassFilterPrivate, parent)
 {}
@@ -68,12 +77,18 @@ QRenderPassFilter::QRenderPassFilter(QRenderPassFilterPrivate &dd, QNode *parent
 {
 }
 
+/*!
+  Returns a vector of the current keys for the filter.
+ */
 QVector<QFilterKey *> QRenderPassFilter::matchAny() const
 {
     Q_D(const QRenderPassFilter);
     return d->m_matchList;
 }
 
+/*!
+  Add the filter key /a filterKey to the match vector.
+ */
 void QRenderPassFilter::addMatch(QFilterKey *filterKey)
 {
     Q_ASSERT(filterKey);
@@ -99,6 +114,9 @@ void QRenderPassFilter::addMatch(QFilterKey *filterKey)
     }
 }
 
+/*!
+  Remove the filter key /a filterKey from the match vector.
+ */
 void QRenderPassFilter::removeMatch(QFilterKey *filterKey)
 {
     Q_ASSERT(filterKey);
@@ -114,6 +132,9 @@ void QRenderPassFilter::removeMatch(QFilterKey *filterKey)
     d->unregisterDestructionHelper(filterKey);
 }
 
+/*!
+  Add the parameter /a parameter to the parameter vector.
+ */
 void QRenderPassFilter::addParameter(QParameter *parameter)
 {
     Q_ASSERT(parameter);
@@ -139,6 +160,9 @@ void QRenderPassFilter::addParameter(QParameter *parameter)
     }
 }
 
+/*!
+  Remove the parameter /a parameter from the parameter vector.
+ */
 void QRenderPassFilter::removeParameter(QParameter *parameter)
 {
     Q_ASSERT(parameter);
@@ -154,6 +178,9 @@ void QRenderPassFilter::removeParameter(QParameter *parameter)
     d->unregisterDestructionHelper(parameter);
 }
 
+/*!
+  Returns the current vector of parameters.
+ */
 QVector<QParameter *> QRenderPassFilter::parameters() const
 {
     Q_D(const QRenderPassFilter);