Adding QDoc to QFrontFace

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

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

1 files changed, 18 insertions, 0 deletions

diff --git a/src/render/renderstates/qfrontface.cpp b/src/render/renderstates/qfrontface.cpp
index 49942ff0d..016f27370 100644
--- a/src/render/renderstates/qfrontface.cpp
+++ b/src/render/renderstates/qfrontface.cpp
@@ -38,6 +38,13 @@
 **
 ****************************************************************************/
 
+/*!
+ * \class QFrontFace
+ * \brief The QFrontFace class defines front and back facing polygons.
+ * \since 5.7
+ * \ingroup renderstates
+ *
+ */
 #include "qfrontface.h"
 #include "qfrontface_p.h"
 #include <Qt3DRender/private/qrenderstatecreatedchange_p.h>
@@ -46,6 +53,10 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * The constructor creates a new QFrontFace::QFrontFace instance with the
+ * specified \a parent
+ */
 QFrontFace::QFrontFace(QNode *parent)
     : QRenderState(*new QFrontFacePrivate, parent)
 {
@@ -56,12 +67,19 @@ QFrontFace::~QFrontFace()
 {
 }
 
+/*!
+ * \return the current winding direction
+ */
 QFrontFace::WindingDirection QFrontFace::direction() const
 {
     Q_D(const QFrontFace);
     return d->m_direction;
 }
 
+/*!
+ * Sets the winding direction to \a direction
+ * \param direction
+ */
 void QFrontFace::setDirection(QFrontFace::WindingDirection direction)
 {
     Q_D(QFrontFace);