Adding QDoc to QStencilTest

Adding skeletal documentation to QStencilTest

Task-number: QTBUG-46037
Change-Id: I9e40d687a9ca48e7e74a9483f402aff68228f857
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

1 files changed, 17 insertions, 0 deletions

diff --git a/src/render/renderstates/qstenciltest.cpp b/src/render/renderstates/qstenciltest.cpp
index 649a78066..2341a3b7d 100644
--- a/src/render/renderstates/qstenciltest.cpp
+++ b/src/render/renderstates/qstenciltest.cpp
@@ -47,6 +47,17 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * \class Qt3DRender::QStencilTest
+ * \brief The QStencilTest class
+ * \since 5.7
+ * \ingroup renderstates
+ */
+
+/*!
+ * The constructor creates a new QStencilTest::QStencilTest instance with
+ * the specified \a parent.
+ */
 QStencilTest::QStencilTest(QNode *parent)
     : QRenderState(*new QStencilTestPrivate, parent)
 {
@@ -57,12 +68,18 @@ QStencilTest::~QStencilTest()
 {
 }
 
+/*!
+ * \return the stencil test for the front
+ */
 QStencilTestArguments *QStencilTest::front() const
 {
     Q_D(const QStencilTest);
     return d->m_front;
 }
 
+/*!
+ * \return the stencil test for the back
+ */
 QStencilTestArguments *QStencilTest::back() const
 {
     Q_D(const QStencilTest);