diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-04-20 10:26:56 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-04-20 10:17:18 +0000 |
| commit | dcda92d3094f35c50c3665059df1b237bf4904b8 (patch) | |
| tree | 67d674255dc29cc237f49f6b0d1940679e71d077 /examples/qt3d | |
| parent | bb09fa7b64b288a68edc61c52ea8467f96eb3924 (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')
3 files changed, 6 insertions, 6 deletions
diff --git a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc index eeb59f07b..0f8a95dab 100644 --- a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc +++ b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc @@ -27,7 +27,7 @@ /*! \example advancedcustommaterial - \title Qt 3D: Advanced custom material QML Example + \title Qt 3D: Advanced Custom Material QML Example \ingroup qt3d-examples-qml \brief Demonstrates creating advanced materials in Qt3D 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. diff --git a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc index 678a8f2d7..d10927d39 100644 --- a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc +++ b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc @@ -27,9 +27,9 @@ /*! \example simplecustommaterial - \title Qt 3D: Simple custom material QML Example + \title Qt 3D: Simple Custom Material QML Example \ingroup qt3d-examples-qml - \brief Demonstrates creating a custom material in Qt3D + \brief Demonstrates creating a custom material in Qt 3D. \image simple-custom-material.jpg @@ -37,7 +37,7 @@ \include examples-run.qdocinc - \section1 Specifying the scene + \section1 Specifying the Scene The example uses \l Scene3D to render a scene which will use the custom material. The scene contains a plane model, which uses the custom material. @@ -46,7 +46,7 @@ \skipto Entity \printto - \section1 Specifying the material + \section1 Specifying the Material The material is specified in \l{simplecustommaterial/SimpleMaterial.qml}{SimpleMaterial.qml} using \l Material type. First the material specifies parameters, |