Doc: Add docs for the Traffic Light example

Change-Id: Id51e2cb7eaf04179efe5379ac82f596ede3f6b04
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>

1 files changed, 36 insertions, 2 deletions

diff --git a/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc b/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
index c2c4dc7..67ec5c8 100644
--- a/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
+++ b/examples/scxml/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
@@ -27,8 +27,42 @@
 
 /*!
     \example trafficlight-qml-dynamic
-    \title Qt SCXML: Traffic Light QML Example (Dynamic)
+    \title Qt SCXML Traffic Light QML Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates using a state-machine for a simple traffic light.
+    \brief A Qt Quick application that uses a dynamically loaded state machine
+    to implement a traffic light.
+
+    \image trafficlight.png
+
+    \e{Traffic Light QML Example (Dynamic)} demonstrates how to connect to the
+    active properties of a state in a dynamically loaded state machine.
+
+    The UI is created using Qt Quick.
+
+    \include examples-run.qdocinc
+
+    \section1 Dynamically Loading the State Machine
+
+    We link against the Qt SCXML module by adding the following line to the
+    example \e .pro file:
+
+    \quotefromfile trafficlight-qml-dynamic/trafficlight-qml-dynamic.pro
+    \skipto QT
+    \printline scxml
+
+    We dynamically create the state machine in the main QML file:
+
+    \quotefromfile trafficlight-qml-dynamic/trafficlight-qml-dynamic.qml
+    \skipto import Scxml
+    \printuntil }
+
+    \include trafficlight-state-machine.qdocinc
+
+    We connect to the states as follows:
+
+    \quotefromfile trafficlight-common/TrafficLight.qml
+    \skipto Light
+    \printuntil greenLight
+    \printuntil /^ {4}\}/
 */