summaryrefslogtreecommitdiffstats
path: root/src/render/doc/src/qt3drenderer-module.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-06-12 15:43:39 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-06-15 11:28:58 +0000
commit60cb61f9d70ec52f3193bac44384099d921827b3 (patch)
treed24608c2e7c438f603c8e566e1b5a45f29d6afcd /src/render/doc/src/qt3drenderer-module.qdoc
parent6f93508bcd38d8d0fa524ac00d65b518fac0d82a (diff)
Doc: Fix multiple documentation issuesv5.5.0-rc1
- Restore qt3d-index.html as the main landing page. Needed for external linking. - Fix \inmodule commands for Renderer classes - Add proper group so that all three modules are listed on the landing page, both C++ and QML modules - Remove qt3drenderer-index.html (to be consistent with Qt3DCore), copy contents over to the module page and to a new file, qt3d-examples.qdoc. - Fix indexTitles in qdocconf files, and subprojects for Renderer QML types and Qt3D examples Change-Id: I0e2497771d0525d120ffa9d7d6338b01fdfa6963 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'src/render/doc/src/qt3drenderer-module.qdoc')
-rw-r--r--src/render/doc/src/qt3drenderer-module.qdoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/render/doc/src/qt3drenderer-module.qdoc b/src/render/doc/src/qt3drenderer-module.qdoc
index 25b551ce4..d927070c3 100644
--- a/src/render/doc/src/qt3drenderer-module.qdoc
+++ b/src/render/doc/src/qt3drenderer-module.qdoc
@@ -40,11 +40,24 @@
\brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D.
\ingroup modules
+ \ingroup qt3d-modules
\qtvariable 3drenderer
The Qt3D Renderer module provides an aspect, components, and other supporting types necessary
to implement 2D and 3D rendering as part of the Qt3D framework.
+ To use classes from this module, add this directive into the C++ files:
+
+ \code
+ #include <Qt3DRenderer>
+ \endcode
+
+ To link against the corresponding C++ library, add the following to your qmake project file:
+
+ \badcode
+ QT += 3drenderer
+ \endcode
+
Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace.
*/
@@ -52,6 +65,7 @@
\qmlmodule Qt3D.Renderer 2.0
\title Qt3D Renderer QML Types
\ingroup qmlmodules
+ \ingroup qt3d-qmlmodules
\brief Provides Qt3D QML types for rendering.