summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3d-module.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/src/qt3d-module.qdoc')
-rw-r--r--src/doc/src/qt3d-module.qdoc35
1 files changed, 29 insertions, 6 deletions
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index cb08a60c0..103d84ff4 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -38,6 +38,19 @@
****************************************************************************/
/*!
+ \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
\brief The Qt 3D module contains functionality to support near-realtime simulation systems.
@@ -74,28 +87,38 @@
*/
/*!
- \page qt3d-qml.html
+ \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
\title Qt 3D QML Types
\brief QML Types for the Qt 3D module.
\since 5.7
+ \ingroup qmlmodules
+ \ingroup qt3d-qmlmodules
- The Qt 3D core QML types are imported with
+ To import and use the module's QML types, use the following statement:
\badcode
import Qt3D.Core 2.0
\endcode
- Other modules import functionality for collision detection, rendering, input,
- and animation. The complete list of Qt 3D import statements:
+ For collision detection, renderer, and input-related QML types, use the
+ following 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