diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-04-13 12:55:34 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-04-14 07:41:11 +0000 |
| commit | f03dc3a2599a0f05cded8b984489b89113c7f037 (patch) | |
| tree | 306902e9865550448dcf035ffa18c0be45834e62 /src/core/doc | |
| parent | 075c0298d1c75dd2d61849b559edcb357d638689 (diff) | |
Doc: Fix multiple C++ documentation issues
- Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
is now able to collate namespace members from multiple modules.
- Mark 'Q...Private' classes and functions taking private arguments as
\internal
- Use correct \qtvariable for Qt 3D Core and Render
- Add src/plugins directory to Qt 3D Core documentation build to
correctly generate Assimp-related documentation.
- Ensure documentation for C++ properties is visible by
using the \property command instead of documenting the
setter/getter functions.
- Add export and logging macros to qdoc ignore directives
- Remove unnecessary use of \fn command
- Language and styling fixes
Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/core/doc')
| -rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 11 | ||||
| -rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 5 |
2 files changed, 12 insertions, 4 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index a1a90a31b..02907b173 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -28,13 +28,20 @@ tagfile = ../../../doc/qt3dcore/qt3dcore.tags depends += qtcore qtqml qtquick qtdoc qt3drender -headerdirs += .. -sourcedirs += .. +headerdirs += .. \ + ../../plugins +sourcedirs += .. \ + ../../plugins exampledirs += src/snippets #excludedirs += imagedirs += images +Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \ + QT3DCORESHARED_EXPORT + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY + navigation.landingpage = "Qt3D Core" navigation.cppclassespage = "Qt3D Core C++ Classes" diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 20cef4e80..453152d85 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -40,7 +40,7 @@ \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. \ingroup modules - \qtvariable qt3dcore + \qtvariable 3dcore The Qt3D Core module provides the foundations and core types used for near-realtime simulations built on the Qt3D framework. @@ -50,6 +50,7 @@ \namespace Qt3D \inmodule Qt3DCore - The Qt3D namespace contains classes and types that are in the foundation of the Qt3D simulation + \brief Contains classes and types that are the foundation of the Qt3D simulation + framework, as well as classes that provide the ability to render using the Qt3D framework. */ |