Doc: Fix documentation warnings related to Clang QDoc parser

Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang
requires a module header, as well as proper include paths, to
build a precompiled header and process the sources.

To do this, add a custom module header that pulls in all Qt 3D modules
- this way, we can continue using a single documentation project to
covers all of Qt 3D.

Fix all documentation warnings are caused by missing namespaces, QML
module/type names and typos, as well as a number of linking problems
and other minor issues.

After this change, the remaining documentation issues consist of
'No documentation for ...' warnings.

Task-number: QTBUG-67790
Change-Id: I38b91163c475a00cc1893e793240470c5409eb57
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

3 files changed, 7 insertions, 7 deletions

diff --git a/src/plugins/sceneparsers/assimp/assimpimporter.cpp b/src/plugins/sceneparsers/assimp/assimpimporter.cpp
index ad53916fd..fdfc095c6 100644
--- a/src/plugins/sceneparsers/assimp/assimpimporter.cpp
+++ b/src/plugins/sceneparsers/assimp/assimpimporter.cpp
@@ -128,7 +128,7 @@ const QString TANGENT_ATTRIBUTE_NAME = QAttribute::defaultTangentAttributeName()
 const QString TEXTCOORD_ATTRIBUTE_NAME = QAttribute::defaultTextureCoordinateAttributeName();
 const QString COLOR_ATTRIBUTE_NAME = QAttribute::defaultColorAttributeName();
 
-/*!
+/*
  * Returns a QMatrix4x4 from \a matrix;
  */
 QMatrix4x4 aiMatrix4x4ToQMatrix4x4(const aiMatrix4x4 &matrix) Q_DECL_NOTHROW
@@ -139,7 +139,7 @@ QMatrix4x4 aiMatrix4x4ToQMatrix4x4(const aiMatrix4x4 &matrix) Q_DECL_NOTHROW
                       matrix.d1, matrix.d2, matrix.d3, matrix.d4);
 }
 
-/*!
+/*
  * Returns a QString from \a str;
  */
 inline QString aiStringToQString(const aiString &str)
@@ -168,7 +168,7 @@ QString texturePath(const aiString &path)
     return p;
 }
 
-/*!
+/*
  * Returns the Qt3DRender::QParameter with named \a name if contained by the material
  * \a material. If the material doesn't contain the named parameter, a new
  * Qt3DRender::QParameter is created and inserted into the material.
diff --git a/src/plugins/sceneparsers/gltf/gltfio.cpp b/src/plugins/sceneparsers/gltf/gltfio.cpp
index c7c7a00dd..bfe99ab3f 100644
--- a/src/plugins/sceneparsers/gltf/gltfio.cpp
+++ b/src/plugins/sceneparsers/gltf/gltfio.cpp
@@ -189,7 +189,7 @@ bool GLTFIO::setJSON(const QJsonDocument &json )
     return true;
 }
 
-/*!
+/*
  * Sets the \a path used by the parser to load the scene file.
  * If the file is valid, parsing is automatically triggered.
  */
@@ -217,7 +217,7 @@ void GLTFIO::setSource(const QUrl &source)
     setBasePath(finfo.dir().absolutePath());
 }
 
-/*!
+/*
  * Returns true if the extension of \a path is supported by the
  * GLTF parser.
  */
diff --git a/src/plugins/sceneparsers/gltf/gltfparser.cpp b/src/plugins/sceneparsers/gltf/gltfparser.cpp
index 8d5696b82..881e7f1b2 100644
--- a/src/plugins/sceneparsers/gltf/gltfparser.cpp
+++ b/src/plugins/sceneparsers/gltf/gltfparser.cpp
@@ -189,7 +189,7 @@ bool GLTFParser::setJSON(const QJsonDocument &json )
     return true;
 }
 
-/*!
+/*
  * Sets the \a path used by the parser to load the scene file.
  * If the file is valid, parsing is automatically triggered.
  */
@@ -215,7 +215,7 @@ void GLTFParser::setSource(const QUrl &source)
     setBasePath(QFileInfo(path).dir().absolutePath());
 }
 
-/*!
+/*
  * Returns true if the extension of \a path is supported by the
  * GLTF parser.
  */