Adding QDoc to QBlendEquation

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

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

1 files changed, 19 insertions, 0 deletions

diff --git a/src/render/renderstates/qblendequation.cpp b/src/render/renderstates/qblendequation.cpp
index fef531f20..de999a19f 100644
--- a/src/render/renderstates/qblendequation.cpp
+++ b/src/render/renderstates/qblendequation.cpp
@@ -38,6 +38,17 @@
 **
 ****************************************************************************/
 
+/*!
+ * \class QBlendEquation
+ * \brief The QBlendEquation class specifies the equation used for both the RGB
+ *  blend equation and the Alpha blend equation
+ * \since 5.7
+ * \ingroup renderstates
+ *
+ * The blend equation is used to determine how a new pixel is combined with a pixel
+ * already in the framebuffer.
+ */
+
 #include "qblendequation.h"
 #include "qblendequation_p.h"
 #include <Qt3DRender/private/qrenderstatecreatedchange_p.h>
@@ -46,6 +57,9 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * The constructor creates a new blend state object with the specified \a parent.
+ */
 QBlendEquation::QBlendEquation(QNode *parent)
     : QRenderState(*new QBlendEquationPrivate, parent)
 {
@@ -62,6 +76,11 @@ QBlendEquation::BlendFunction QBlendEquation::blendFunction() const
     return d->m_blendFunction;
 }
 
+/*!
+ * Sets the function used to decide how the source and destination colors are combined,
+ * to \a blendFunction.
+ * \param blendFunction
+ */
 void QBlendEquation::setBlendFunction(QBlendEquation::BlendFunction blendFunction)
 {
     Q_D(QBlendEquation);