Add a short description to the examples overview doc.

Change-Id: I036bc1e6e73427a7678b14dbaf51169be0471f92
Reviewed-by: Erik Verbruggen <erik.verbruggen@theqtcompany.com>

13 files changed, 17 insertions, 15 deletions

diff --git a/TODO.txt b/TODO.txt
index 67e8e23..0c67591 100644
--- a/TODO.txt
+++ b/TODO.txt
@@ -2,12 +2,9 @@
 - code review
 - qmake review
 - check all messages to have the same format
-- document nonconformance with w3c-ecma/test558 (modified by us) - we always expect js expression in <data>'s non-XML children or in external file referenced by src attribute of <data> element.
 
 For TP:
 - review examples
-- add minimal explanation for examples
-- Have Topi check the docs
 - rename master branch to dev
 - branch 5.6 off of dev
 - remove this file
diff --git a/examples/invoke-dynamic/doc/src/invoke-dynamic.qdoc b/examples/invoke-dynamic/doc/src/invoke-dynamic.qdoc
index ba813aa..280520d 100644
--- a/examples/invoke-dynamic/doc/src/invoke-dynamic.qdoc
+++ b/examples/invoke-dynamic/doc/src/invoke-dynamic.qdoc
@@ -21,5 +21,6 @@
     \title Qt SCXML: Invoke Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates the use of <invoke> and the use of the generated/created
+           nested state-machines, where the SCXML file dynamically loaded.
 */
diff --git a/examples/invoke-static/doc/src/invoke-static.qdoc b/examples/invoke-static/doc/src/invoke-static.qdoc
index 8d4705f..d225fe2 100644
--- a/examples/invoke-static/doc/src/invoke-static.qdoc
+++ b/examples/invoke-static/doc/src/invoke-static.qdoc
@@ -21,5 +21,6 @@
     \title Qt SCXML: Invoke Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates the use of <invoke> and the use of the generated/created
+           nested state-machines, where the SCXML file is compiled to C++ first.
 */
diff --git a/examples/mediaplayer-qml-cppdatamodel/doc/src/mediaplayer-qml-cppdatamodel.qdoc b/examples/mediaplayer-qml-cppdatamodel/doc/src/mediaplayer-qml-cppdatamodel.qdoc
index 16e2238..2907bc5 100644
--- a/examples/mediaplayer-qml-cppdatamodel/doc/src/mediaplayer-qml-cppdatamodel.qdoc
+++ b/examples/mediaplayer-qml-cppdatamodel/doc/src/mediaplayer-qml-cppdatamodel.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Media Player QML Example (C++ Data Model)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates how to send/receive data to/from a C++ data-model.
 */
diff --git a/examples/mediaplayer-qml-dynamic/doc/src/mediaplayer-qml-dynamic.qdoc b/examples/mediaplayer-qml-dynamic/doc/src/mediaplayer-qml-dynamic.qdoc
index 4acde84..1f8ef50 100644
--- a/examples/mediaplayer-qml-dynamic/doc/src/mediaplayer-qml-dynamic.qdoc
+++ b/examples/mediaplayer-qml-dynamic/doc/src/mediaplayer-qml-dynamic.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Media Player QML Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates how to send/receive data to/from EcmaScript data-model.
 */
diff --git a/examples/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc b/examples/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
index 8e65578..32e5a3f 100644
--- a/examples/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
+++ b/examples/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Media Player QML Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates how to send/receive data to/from EcmaScript data-model.
 */
diff --git a/examples/mediaplayer-widgets-dynamic/doc/src/mediaplayer-widgets-dynamic.qdoc b/examples/mediaplayer-widgets-dynamic/doc/src/mediaplayer-widgets-dynamic.qdoc
index 781b838..393bec6 100644
--- a/examples/mediaplayer-widgets-dynamic/doc/src/mediaplayer-widgets-dynamic.qdoc
+++ b/examples/mediaplayer-widgets-dynamic/doc/src/mediaplayer-widgets-dynamic.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Media Player Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates how to send/receive data to/from EcmaScript data-model.
 */
diff --git a/examples/mediaplayer-widgets-static/doc/src/mediaplayer-widgets-static.qdoc b/examples/mediaplayer-widgets-static/doc/src/mediaplayer-widgets-static.qdoc
index eb2db04..83c2701 100644
--- a/examples/mediaplayer-widgets-static/doc/src/mediaplayer-widgets-static.qdoc
+++ b/examples/mediaplayer-widgets-static/doc/src/mediaplayer-widgets-static.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Media Player Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates how to send/receive data to/from EcmaScript data-model.
 */
diff --git a/examples/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc b/examples/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
index a8c1f47..100aaf8 100644
--- a/examples/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
+++ b/examples/trafficlight-qml-dynamic/doc/src/trafficlight-qml-dynamic.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Traffic Light QML Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates using a state-machine for a simple traffic light.
 */
diff --git a/examples/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc b/examples/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
index 26762e3..4e92276 100644
--- a/examples/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
+++ b/examples/trafficlight-qml-static/doc/src/trafficlight-qml-static.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Traffic Light QML Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates using a state-machine for a simple traffic light.
 */
diff --git a/examples/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc b/examples/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
index d2c288e..82f414c 100644
--- a/examples/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
+++ b/examples/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Traffic Light Example (Dynamic)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates using a state-machine for a simple traffic light.
 */
diff --git a/examples/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc b/examples/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
index 67e8cff..1c92f5a 100644
--- a/examples/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
+++ b/examples/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.qdoc
@@ -21,5 +21,5 @@
     \title Qt SCXML: Traffic Light Example (Static)
     \ingroup examples-qtscxml
 
-    \brief Demonstrates...
+    \brief Demonstrates using a state-machine for a simple traffic light.
 */
diff --git a/src/scxml/doc/qtscxml-examples.qdoc b/src/scxml/doc/qtscxml-examples.qdoc
index 7b63524..072692c 100644
--- a/src/scxml/doc/qtscxml-examples.qdoc
+++ b/src/scxml/doc/qtscxml-examples.qdoc
@@ -23,5 +23,8 @@
 \ingroup all-examples
 
 Here is a list of example applications demonstrating the functionality
-provided by the \l{Qt SCXML} module.
+provided by the \l{Qt SCXML} module. Some examples come in multiple flavors,
+e.g. the traffic-light example. All of these use the same SCXML file, but
+implement the UI differently (C++ versus QML), or load the SCXML dynamically
+versus compiling it to C++ first (the "static" versions).
 */