summaryrefslogtreecommitdiffstats
path: root/src/plugins/sceneparsers/gltf
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-04-20 10:26:56 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2018-04-20 10:17:18 +0000
commitdcda92d3094f35c50c3665059df1b237bf4904b8 (patch)
tree67d674255dc29cc237f49f6b0d1940679e71d077 /src/plugins/sceneparsers/gltf
parentbb09fa7b64b288a68edc61c52ea8467f96eb3924 (diff)
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>
Diffstat (limited to 'src/plugins/sceneparsers/gltf')
-rw-r--r--src/plugins/sceneparsers/gltf/gltfio.cpp4
-rw-r--r--src/plugins/sceneparsers/gltf/gltfparser.cpp4
2 files changed, 4 insertions, 4 deletions
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.
*/