Doc: Fix multiple C++ documentation issues

    - Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
      is now able to collate namespace members from multiple modules.
    - Mark 'Q...Private' classes and functions taking private arguments as
      \internal
    - Use correct \qtvariable for Qt 3D Core and Render
    - Add src/plugins directory to Qt 3D Core documentation build to
      correctly generate Assimp-related documentation.
    - Ensure documentation for C++ properties is visible by
      using the \property command instead of documenting the
      setter/getter functions.
    - Add export and logging macros to qdoc ignore directives
    - Remove unnecessary use of \fn command
    - Language and styling fixes

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

1 files changed, 14 insertions, 23 deletions

diff --git a/src/render/frontend/qcolormask.cpp b/src/render/frontend/qcolormask.cpp
index 22f130134..95e2e69b2 100644
--- a/src/render/frontend/qcolormask.cpp
+++ b/src/render/frontend/qcolormask.cpp
@@ -61,16 +61,15 @@ public:
 };
 
 /*!
-
     \class Qt3D::QColorMask
 
-    \brief QColorMask allows to specify which color components should be written
-    to the currently bound frame buffer.
+    \brief Allows specifying which color components should be written to the
+    currently bound frame buffer.
 
-    By default each color component (red, green, blue, alpha) is set to true
-    which means they will be written to the frame buffer. Setting any of the
-    color component to false will prevent it from being written into the frame
-    buffer.
+    By default, the property for each color component (red, green, blue, alpha)
+    is set to \c true which means they will be written to the frame buffer.
+    Setting any of the color component to \c false will prevent it from being
+    written into the frame buffer.
  */
 
 
@@ -86,36 +85,24 @@ QColorMask::~QColorMask()
 {
 }
 
-/*!
-    \return whether the red color component should be written to the frame buffer;
- */
 bool QColorMask::isRed() const
 {
     Q_D(const QColorMask);
     return d->m_red;
 }
 
-/*!
-    \return whether the green color component should be written to the frame buffer;
- */
 bool QColorMask::isGreen() const
 {
     Q_D(const QColorMask);
     return d->m_green;
 }
 
-/*!
-    \return whether the blue color component should be written to the frame buffer;
- */
 bool QColorMask::isBlue() const
 {
     Q_D(const QColorMask);
     return d->m_blue;
 }
 
-/*!
-    \return whether the alpha color component should be written to the frame buffer;
- */
 bool QColorMask::isAlpha() const
 {
     Q_D(const QColorMask);
@@ -123,7 +110,8 @@ bool QColorMask::isAlpha() const
 }
 
 /*!
-    Sets whether the \a red color component should be written to the frame buffer;
+    \property Qt3D::QColorMask::red
+    Holds whether the red color component should be written to the frame buffer.
  */
 void QColorMask::setRed(bool red)
 {
@@ -135,7 +123,8 @@ void QColorMask::setRed(bool red)
 }
 
 /*!
-    Sets whether the \a greem color component should be written to the frame buffer;
+    \property Qt3D::QColorMask::green
+    Holds whether the green color component should be written to the frame buffer.
  */
 void QColorMask::setGreen(bool green)
 {
@@ -147,7 +136,8 @@ void QColorMask::setGreen(bool green)
 }
 
 /*!
-    Sets whether the \a blue color component should be written to the frame buffer;
+    \property Qt3D::QColorMask::blue
+    Holds whether the blue color component should be written to the frame buffer.
  */
 void QColorMask::setBlue(bool blue)
 {
@@ -159,7 +149,8 @@ void QColorMask::setBlue(bool blue)
 }
 
 /*!
-    Sets whether the \a alpha color component should be written to the frame buffer;
+    \property Qt3D::QColorMask::alpha
+    Holds whether the alpha component should be written to the frame buffer.
  */
 void QColorMask::setAlpha(bool alpha)
 {