Adding QDoc to QStencilOperation

Adding documentation to aid in the explanation
of how to use QStencilOperation and its general
relation to OpenGL

Change-Id: I5ba0c256f24871f3b6e76c9d3915e33c46154930
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

1 files changed, 18 insertions, 0 deletions

diff --git a/src/render/renderstates/qstenciloperation.cpp b/src/render/renderstates/qstenciloperation.cpp
index cec14c041..0b3842c53 100644
--- a/src/render/renderstates/qstenciloperation.cpp
+++ b/src/render/renderstates/qstenciloperation.cpp
@@ -37,6 +37,14 @@
 **
 ****************************************************************************/
 
+/*!
+ * \class QStencilOperation
+ * \brief The QStencilOperation class allows the selection of either the front
+ * or back sides.
+ * \since 5.7
+ * \ingroup renderstates
+ */
+
 #include "qstenciloperation.h"
 #include "qstenciloperation_p.h"
 #include "qstenciloperationarguments.h"
@@ -46,6 +54,10 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * The constructor creates a new QStencilOperation::QStencilOperation instance with
+ * the specified \a parent.
+ */
 QStencilOperation::QStencilOperation(QNode *parent)
     : QRenderState(*new QStencilOperationPrivate(), parent)
 {
@@ -56,12 +68,18 @@ QStencilOperation::~QStencilOperation()
 {
 }
 
+/*!
+ * \return the front fragments.
+ */
 QStencilOperationArguments *QStencilOperation::front() const
 {
     Q_D(const QStencilOperation);
     return d->m_front;
 }
 
+/*!
+ * \return the back fragments.
+ */
 QStencilOperationArguments *QStencilOperation::back() const
 {
     Q_D(const QStencilOperation);