Adding QDoc to QScissorTest

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

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

1 files changed, 41 insertions, 0 deletions

diff --git a/src/render/renderstates/qscissortest.cpp b/src/render/renderstates/qscissortest.cpp
index 0897a52c4..e363ba54d 100644
--- a/src/render/renderstates/qscissortest.cpp
+++ b/src/render/renderstates/qscissortest.cpp
@@ -38,6 +38,15 @@
 **
 ****************************************************************************/
 
+/*!
+ * \class QScissorTest
+ * \brief The QScissorTest class discards fragments that fall outside of a
+ * certain rectangular portion of the screen.
+ * \since 5.7
+ * \ingroup renderstates
+ *
+ */
+
 #include "qscissortest.h"
 #include "qscissortest_p.h"
 #include <Qt3DRender/private/qrenderstatecreatedchange_p.h>
@@ -46,6 +55,10 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * The constructor creates a new QScissorTest::QScissorTest instance with the
+ * specified \a parent
+ */
 QScissorTest::QScissorTest(QNode *parent)
     : QRenderState(*new QScissorTestPrivate, parent)
 {
@@ -56,12 +69,19 @@ QScissorTest::~QScissorTest()
 {
 }
 
+/*!
+ * \return the left of the scissor box
+ */
 int QScissorTest::left() const
 {
     Q_D(const QScissorTest);
     return d->m_left;
 }
 
+/*!
+ * Sets the left of the scissor box to \a setLeft
+ * \param left
+ */
 void QScissorTest::setLeft(int left)
 {
     Q_D(QScissorTest);
@@ -71,12 +91,19 @@ void QScissorTest::setLeft(int left)
     }
 }
 
+/*!
+ * \return the bottom of the scrissor box
+ */
 int QScissorTest::bottom() const
 {
     Q_D(const QScissorTest);
     return d->m_bottom;
 }
 
+/*!
+ * Sets the bottom of the scissor box to \a bottom
+ * \param bottom
+ */
 void QScissorTest::setBottom(int bottom)
 {
     Q_D(QScissorTest);
@@ -86,12 +113,19 @@ void QScissorTest::setBottom(int bottom)
     }
 }
 
+/*!
+ * \return the width of the scissor box
+ */
 int QScissorTest::width() const
 {
     Q_D(const QScissorTest);
     return d->m_width;
 }
 
+/*!
+ * Sets the width of the scissor box to \a width
+ * \param width
+ */
 void QScissorTest::setWidth(int width)
 {
     Q_D(QScissorTest);
@@ -101,12 +135,19 @@ void QScissorTest::setWidth(int width)
     }
 }
 
+/*!
+ * \return the height of the scissor box
+ */
 int QScissorTest::height() const
 {
     Q_D(const QScissorTest);
     return d->m_height;
 }
 
+/*!
+ * Sets the height of the scissor box to \a height
+ * \param height
+ */
 void QScissorTest::setHeight(int height)
 {
     Q_D(QScissorTest);