Doc: Add docs for the Traffic Light example

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

1 files changed, 31 insertions, 2 deletions

diff --git a/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc b/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
index 03e0680..a807f22 100644
--- a/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
+++ b/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
@@ -27,8 +27,37 @@
 
 /*!
     \example trafficlight-widgets-static
-    \title Qt SCXML: Traffic Light Example (Static)
+    \title Qt SCXML Traffic Light Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates using a state-machine for a simple traffic light.
+    \brief A widget-based application that uses a compiled state machine to
+    implement a traffic light.
+
+    \image trafficlight.png
+
+    \e{Traffic Light Example (Static)} demonstrates how to connect to the
+    active properties of a state in a state machine that is compiled to a class.
+
+    The UI is created using Qt Widgets.
+
+    \include examples-run.qdocinc
+
+    \include trafficlight-compiling.qdocinc
+
+    \section1 Instantiating the State Machine
+
+    We instantiate the generated \c TrafficLightStateMachine class in the
+    \e trafficlight-widgets-static.cpp file, as follows:
+
+    \quotefromfile trafficlight-widgets-static/trafficlight-widgets-static.cpp
+    \skipto #include
+    \printuntil }
+
+    \include trafficlight-state-machine.qdocinc
+
+    We connect to the states as follows:
+
+    \quotefromfile trafficlight-common/trafficlight.cpp
+    \skipto connectToState
+    \printuntil greenLight
 */