summaryrefslogtreecommitdiffstats
path: root/src/render/doc/src/qt3drender-index.qdoc
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2015-01-28 14:02:20 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2015-03-16 13:35:11 +0000
commitc9428e47d5d9300fe8daac03f27f813d7825d8b0 (patch)
tree7ed33db87b59485d718ef267ec1c392302506fcb /src/render/doc/src/qt3drender-index.qdoc
parent5800a996e790bf137ebe7b4c8454c2c266c8a165 (diff)
Doc: Review doc Qt3D
Task-number: QTBUG-44180 Change-Id: Ia5ce031397f9b03c5ba692aa30b6097dc60e59e3 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/render/doc/src/qt3drender-index.qdoc')
-rw-r--r--src/render/doc/src/qt3drender-index.qdoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/render/doc/src/qt3drender-index.qdoc b/src/render/doc/src/qt3drender-index.qdoc
index 620b39975..a29238f95 100644
--- a/src/render/doc/src/qt3drender-index.qdoc
+++ b/src/render/doc/src/qt3drender-index.qdoc
@@ -42,5 +42,20 @@
\section1 Getting Started
+ To use Qt3D classes, add this directive into the C++ files:
+ \code
+ #include <Qt3DRenderer>
+ \endcode
+
+ To link against the corresponding C++ libraries, add the following to your qmake project file:
+
+ \code
+ QT += 3drenderer
+ \endcode
+
+ \section1 Reference
+ \list
+ \li \l {Qt3D Render C++ Classes}
+ \endlist
*/