summaryrefslogtreecommitdiffstats
path: root/src/render/doc/src/qt3drenderer-module.qdoc
diff options
context:
space:
mode:
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.