From dcda92d3094f35c50c3665059df1b237bf4904b8 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 20 Apr 2018 10:26:56 +0200 Subject: Doc: Fix documentation warnings related to Clang QDoc parser MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö --- src/doc/src/qt3d-index.qdoc | 2 +- src/doc/src/qt3d-module.qdoc | 35 ++++++----------------------------- src/doc/src/qt3d-overview.qdoc | 8 ++++++-- 3 files changed, 13 insertions(+), 32 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 0e889e652..eaeaf789e 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -68,7 +68,7 @@ For a C++ application that performs 2D or 3D rendering, collision detection, and also handle user input, add the following line to its - \l qmake \c .pro file: + qmake \c .pro file: \badcode QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index 103d84ff4..cb08a60c0 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -37,19 +37,6 @@ ** ****************************************************************************/ -/*! - \module Qt3DCore - \title Qt 3D Core C++ Classes - \brief The Qt 3D module contains functionality to support near-realtime simulation systems. - - \ingroup modules - \ingroup qt3d-modules - \qtvariable 3dcore - - The Qt 3D module provides the foundations and core types used for near-realtime - simulations built on the Qt 3D framework. -*/ - /*! \page qt3d-cpp.html \title Qt 3D C++ Classes @@ -87,38 +74,28 @@ */ /*! - \namespace Qt3DCore - \inmodule Qt3DCore - \ingroup qt3d-namespaces - - \brief Contains classes that are the foundation for Qt 3D simulation - framework, as well as classes that provide the ability to render using the - Qt 3D framework. -*/ - -/*! - \qmlmodule Qt3D.Core 2.0 + \page qt3d-qml.html \title Qt 3D QML Types \brief QML Types for the Qt 3D module. \since 5.7 - \ingroup qmlmodules - \ingroup qt3d-qmlmodules - To import and use the module's QML types, use the following statement: + The Qt 3D core QML types are imported with \badcode import Qt3D.Core 2.0 \endcode - For collision detection, renderer, and input-related QML types, use the - following import statements: + Other modules import functionality for collision detection, rendering, input, + and animation. The complete list of Qt 3D import statements: \badcode + import Qt3D.Core 2.0 import Qt3D.Render 2.0 import Qt3D.Input 2.0 import Qt3D.Logic 2.0 import Qt3D.Extras 2.0 import Qt3D.Animation 2.9 + import Qt3D.Scene2D 2.9 \endcode \section1 QML Types diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index e1f3d8629..2b261ebbc 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -88,8 +88,12 @@ variables in a GLSL shader program that is itself specified in the referenced effect property. - For examples of using materials, see the \l {Qt 3D: Materials C++ Example} - and \l {Qt 3D: Materials QML Example}. + For examples of using materials, see the following examples: + \list + \li \l {Qt 3D: Simple Custom Material QML Example} + \li \l {Qt 3D: Advanced Custom Material QML Example} + \li \l {Qt 3D: PBR Materials QML Example} + \endlist \section2 Shaders -- cgit v1.2.3