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, 13 insertions, 29 deletions

diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp
index a6e336776..68023e3a1 100644
--- a/src/render/defaults/qphongmaterial.cpp
+++ b/src/render/defaults/qphongmaterial.cpp
@@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3D {
 
+/*!
+    \class Qt3D::QPhongMaterialPrivate
+    \internal
+*/
 QPhongMaterialPrivate::QPhongMaterialPrivate(QPhongMaterial *qq)
     : QMaterialPrivate(qq)
     , m_phongEffect(new QEffect())
@@ -110,16 +114,16 @@ QPhongMaterial::QPhongMaterial(QNode *parent)
 /*!
    \fn Qt3D::QPhongMaterial::~QPhongMaterial()
 
-   Destroys the QPhongMaterial
+   Destroys the QPhongMaterial.
 */
 QPhongMaterial::~QPhongMaterial()
 {
 }
 
 /*!
-    \fn QColor Qt3D::QPhongMaterial::ambient() const
+    \property Qt3D::QPhongMaterial::ambient
 
-    Returns the ambient color.
+    Holds the ambient color.
 */
 QColor QPhongMaterial::ambient() const
 {
@@ -128,9 +132,9 @@ QColor QPhongMaterial::ambient() const
 }
 
 /*!
-    \fn QColor Qt3D::QPhongMaterial::diffuse() const
+    \property Qt3D::QPhongMaterial::diffuse
 
-    Returns the diffuse color.
+    Holds the diffuse color.
 */
 QColor QPhongMaterial::diffuse() const
 {
@@ -139,9 +143,9 @@ QColor QPhongMaterial::diffuse() const
 }
 
 /*!
-    \fn QColor Qt3D::QPhongMaterial::specular() const
+    \property QColor Qt3D::QPhongMaterial::specular
 
-    Returns the specular color.
+    Holds the specular color.
 */
 QColor QPhongMaterial::specular() const
 {
@@ -150,9 +154,9 @@ QColor QPhongMaterial::specular() const
 }
 
 /*!
-    \fn Qt3D::QPhongMaterial::shininess() const
+    \property Qt3D::QPhongMaterial::shininess
 
-    Returns the shininess exponent.
+    Holds the shininess exponent.
 */
 float QPhongMaterial::shininess() const
 {
@@ -160,44 +164,24 @@ float QPhongMaterial::shininess() const
     return d->m_shininessParameter->value().toFloat();
 }
 
-/*!
-    \fn Qt3D::QPhongMaterial::setAmbient(const QColor &ambient)
-
-    Sets the current ambient color to \a ambient.
-*/
 void QPhongMaterial::setAmbient(const QColor &ambient)
 {
     Q_D(QPhongMaterial);
     d->m_shininessParameter->setValue(ambient);
 }
 
-/*!
-    \fn Qt3D::QPhongMaterial::setDiffuse(const QColor &diffuse)
-
-    Sets the current diffuse color to \a diffuse.
-*/
 void QPhongMaterial::setDiffuse(const QColor &diffuse)
 {
     Q_D(QPhongMaterial);
     d->m_diffuseParameter->setValue(diffuse);
 }
 
-/*!
-    \fn Qt3D::QPhongMaterial::setSpecular(const QColor &specular)
-
-    Sets the current specular color to \a specular.
-*/
 void QPhongMaterial::setSpecular(const QColor &specular)
 {
     Q_D(QPhongMaterial);
     d->m_specularParameter->setValue(specular);
 }
 
-/*!
-    \fn Qt3D::QPhongMaterial::setShininess(float shininess)
-
-    Sets the current shininess exponent to \a shininess.
-*/
 void QPhongMaterial::setShininess(float shininess)
 {
     Q_D(QPhongMaterial);