diff options
| author | Nico Vertriest <nico.vertriest@digia.com> | 2015-01-28 14:02:20 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-03-16 13:35:11 +0000 |
| commit | c9428e47d5d9300fe8daac03f27f813d7825d8b0 (patch) | |
| tree | 7ed33db87b59485d718ef267ec1c392302506fcb /src/core/doc | |
| parent | 5800a996e790bf137ebe7b4c8454c2c266c8a165 (diff) | |
Doc: Review doc Qt3D
Task-number: QTBUG-44180
Change-Id: Ia5ce031397f9b03c5ba692aa30b6097dc60e59e3
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'src/core/doc')
| -rw-r--r-- | src/core/doc/src/qt3dcore-index.qdoc | 23 | ||||
| -rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 2 |
2 files changed, 21 insertions, 4 deletions
diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc index 5e9e45d14..4fc04112d 100644 --- a/src/core/doc/src/qt3dcore-index.qdoc +++ b/src/core/doc/src/qt3dcore-index.qdoc @@ -35,12 +35,29 @@ ****************************************************************************/ /*! - \page qt3dcore-index.html - \title Qt3D Core + \title Qt3D Core + \page qt3dcore-index.html + \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. - \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. \section1 Getting Started + To use Qt3D classes, add this directive into the C++ files: + + \code + #include <Qt3DCore> + \endcode + + To link against the corresponding C++ libraries, add the following to your qmake project file: + + \code + QT += 3dcore + \endcode + + \section1 Reference + + \list + \li \l {Qt3D Core C++ Classes} + \endlist */ diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 8ff5473b3..20cef4e80 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -36,7 +36,7 @@ /*! \module Qt3DCore - \title Qt3D Core + \title Qt3D Core C++ Classes \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. \ingroup modules |