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>

1 files changed, 28 insertions, 1 deletions

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);