summaryrefslogtreecommitdiffstats
path: root/examples/qt3d/pbr-materials
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 /examples/qt3d/pbr-materials
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 'examples/qt3d/pbr-materials')
-rw-r--r--examples/qt3d/pbr-materials/doc/src/materials.qdoc2
1 files changed, 1 insertions, 1 deletions
diff --git a/examples/qt3d/pbr-materials/doc/src/materials.qdoc b/examples/qt3d/pbr-materials/doc/src/materials.qdoc
index c96bb0843..7a0e5d9a4 100644
--- a/examples/qt3d/pbr-materials/doc/src/materials.qdoc
+++ b/examples/qt3d/pbr-materials/doc/src/materials.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \example materials
+ \example pbr-materials
\title Qt 3D: PBR Materials QML Example
\ingroup qt3d-examples-qml
\brief A QML application that demonstrates using PBR materials.