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, 31 insertions, 35 deletions

diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp
index a32cb3c3a..117f3ecbb 100644
--- a/src/render/defaults/qdiffusemapmaterial.cpp
+++ b/src/render/defaults/qdiffusemapmaterial.cpp
@@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3D {
 
+/*!
+    \class Qt3D::QDiffuseMapMaterialPrivate
+    \internal
+*/
 QDiffuseMapMaterialPrivate::QDiffuseMapMaterialPrivate(QDiffuseMapMaterial *qq)
     : QMaterialPrivate(qq)
     , m_diffuseMapEffect(new QEffect())
@@ -146,7 +150,6 @@ void QDiffuseMapMaterialPrivate::init()
 */
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::QDiffuseMapMaterial()
     Constructs a new Qt3D::QDiffuseMapMaterial instance with parent object \a parent.
  */
 
@@ -162,13 +165,17 @@ QDiffuseMapMaterial::QDiffuseMapMaterial(QNode *parent)
     d->init();
 }
 
+/*!
+    Destroys the QDiffuseMapMaterial instance.
+*/
 QDiffuseMapMaterial::~QDiffuseMapMaterial()
 {
 }
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::ambient() const
-    \return the current QColor ambient value.
+    \property Qt3D::QDiffuseMapMaterial::ambient
+
+    Holds the current ambient color.
  */
 QColor QDiffuseMapMaterial::ambient() const
 {
@@ -177,8 +184,9 @@ QColor QDiffuseMapMaterial::ambient() const
 }
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::specular() const
-    \return the current QColor specular value.
+    \property Qt3D::QDiffuseMapMaterial::specular
+
+    Holds the current specular color.
  */
 QColor QDiffuseMapMaterial::specular() const
 {
@@ -187,8 +195,9 @@ QColor QDiffuseMapMaterial::specular() const
 }
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::shininess() const
-    \return the current shininess as a float value.
+    \property Qt3D::QDiffuseMapMaterial::shininess
+
+    Holds the current shininess as a float value.
  */
 float QDiffuseMapMaterial::shininess() const
 {
@@ -197,12 +206,18 @@ float QDiffuseMapMaterial::shininess() const
 }
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::diffuse() const
-    \return the current QTexture used as the diffuse map.
-    \b {Note:} By default the diffuse texture has a linear
-    magnification filter, a linear mipmap linear minification filter,
-    the wrap mode is repeat, the maximum anisotropy is set to 16.0
-    and mipmapping is enabled.
+    \property Qt3D::QDiffuseMapMaterial::diffuse
+
+    Holds the current QTexture used as the diffuse map.
+
+    By default, the diffuse texture has the following properties:
+
+    \list
+        \li Linear minification and magnification filters
+        \li Linear mipmap with mipmapping enabled
+        \li Repeat wrap mode
+        \li Maximum anisotropy of 16.0
+    \endlist
  */
 QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const
 {
@@ -211,8 +226,9 @@ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const
 }
 
 /*!
-    \fn Qt3D::QDiffuseMapMaterial::textureScale() const
-    \return the current texture scale.
+    \property Qt3D::QDiffuseMapMaterial::textureScale
+
+    Holds the current texture scale as a float value.
  */
 float QDiffuseMapMaterial::textureScale() const
 {
@@ -220,50 +236,30 @@ float QDiffuseMapMaterial::textureScale() const
     return d->m_textureScaleParameter->value().toFloat();
 }
 
-/*!
-    \fn Qt3D::QDiffuseMapMaterial::setAmbient(const QColor &ambient)
-    Sets the current ambient color to \a ambient.
- */
 void QDiffuseMapMaterial::setAmbient(const QColor &ambient)
 {
     Q_D(const QDiffuseMapMaterial);
     d->m_ambientParameter->setValue(ambient);
 }
 
-/*!
-    \fn Qt3D::QDiffuseMapMaterial::setSpecular(const QColor &specular)
-    Sets the current specular color to \a specular.
- */
 void QDiffuseMapMaterial::setSpecular(const QColor &specular)
 {
     Q_D(QDiffuseMapMaterial);
     d->m_specularParameter->setValue(specular);
 }
 
-/*!
-    \fn Qt3D::QDiffuseMapMaterial::setShininess(float shininess)
-    Sets the current shininess value to \a shininess.
- */
 void QDiffuseMapMaterial::setShininess(float shininess)
 {
     Q_D(QDiffuseMapMaterial);
     d->m_shininessParameter->setValue(shininess);
 }
 
-/*!
-    \fn Qt3D::QDiffuseMapMaterial::setDiffuse(QTexture *diffuseMap)
-    Sets the current diffuse map to \a diffuseMap.
- */
 void QDiffuseMapMaterial::setDiffuse(QAbstractTextureProvider *diffuseMap)
 {
     Q_D(QDiffuseMapMaterial);
     d->m_diffuseParameter->setValue(QVariant::fromValue(diffuseMap));
 }
 
-/*!
-    \fn Qt3D::QDiffuseMapMaterial::setTextureScale(float textureScale)
-    Sets the current texture scale to \a textureScale.
- */
 void QDiffuseMapMaterial::setTextureScale(float textureScale)
 {
     Q_D(QDiffuseMapMaterial);