Documentation for basic shapes example

Add the documentation for the basic shapes example.

Change-Id: I9a69198ddbd188ddaa7bd4ab0fae0dc2315719a9
Reviewed-by: Tomi Korpipää <tomi.korpipaa@theqtcompany.com>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

2 files changed, 37 insertions, 0 deletions

diff --git a/examples/qt3d/basicshapes-cpp/doc/images/basicshapes-cpp-example.jpg b/examples/qt3d/basicshapes-cpp/doc/images/basicshapes-cpp-example.jpg
new file mode 100644
index 000000000..cdf694427
--- /dev/null
+++ b/examples/qt3d/basicshapes-cpp/doc/images/basicshapes-cpp-example.jpg
diff --git a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
index f408bc43b..004b06817 100644
--- a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
+++ b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
@@ -29,4 +29,41 @@
     \example basicshapes-cpp
     \title Qt3D: Basic Shapes C++ Example
     \ingroup qt3d-examples-cpp
+    \brief Shows four basic shapes that Qt3D offers.
+
+    The Basic Shapes examples shows four basic shapes that Qt3D offers, a torus,
+    a cylinder, a cube and a sphere. The example also shows how to embed a Qt3D scene
+    into a widget and connect with other widgets.
+
+    \image basicshapes-cpp-example.jpg
+
+    As an example let's go through how to set up a torus mesh. First instantiate
+    the \c QTorusMesh, and then set the mesh specific parameters, that for torus are
+    radius, minor radius and how many rings and slices.
+
+    \snippet basicshapes-cpp/scenemodifier.cpp 0
+
+    The size and position of the torus can be adjusted with transform components.
+    We create scale, translation and rotation components and add them into the
+    \c QTransform component.
+
+    \snippet basicshapes-cpp/scenemodifier.cpp 1
+
+    To change the diffuse color of the mesh we create a \c QPhongMaterial and set
+    its diffuse color.
+
+    \snippet basicshapes-cpp/scenemodifier.cpp 2
+
+    The final step is to add the torus into an entity tree, and we do that by creating
+    a \c QEntity with parent entity and adding the previously created mesh, material
+    and transform components into it.
+
+    \snippet basicshapes-cpp/scenemodifier.cpp 3
+
+    You can control the visibility of the entity by defining if it has parent
+    or not, i.e. whether it is part of entity tree or not.
+
+    \snippet basicshapes-cpp/scenemodifier.cpp 4
+
+
 */