summaryrefslogtreecommitdiffstats
path: root/examples/scxml/mediaplayer-qml-static/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2016-03-09 16:59:06 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2016-03-15 15:01:14 +0000
commit93ba677a1c1661710a8a6e20140858ef238eda21 (patch)
tree4adb539717ad645ff517aecd23d201d34910665b /examples/scxml/mediaplayer-qml-static/doc
parent7d0c11c64f61d5ef6e5bd6513ddd6387bb6ae92e (diff)
Doc: Add docs for Mediaplayer example versions
- Add screenshot - Use include files for info common to several app versions - Add examples directory to sourcedirs in the .qdocconf file to be able to put the include files to the mediaplayer-common folder Change-Id: I411d74d51d17b9ed5d906e23ede3b64e3b6b2dac Reviewed-by: Ulf Hermann <ulf.hermann@theqtcompany.com>
Diffstat (limited to 'examples/scxml/mediaplayer-qml-static/doc')
-rw-r--r--examples/scxml/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc27
1 files changed, 25 insertions, 2 deletions
diff --git a/examples/scxml/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc b/examples/scxml/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
index 427a100..4232ff1 100644
--- a/examples/scxml/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
+++ b/examples/scxml/mediaplayer-qml-static/doc/src/mediaplayer-qml-static.qdoc
@@ -27,8 +27,31 @@
/*!
\example mediaplayer-qml-static
- \title Qt SCXML: Media Player QML Example (Static)
+ \title Qt SCXML Media Player QML Example (Static)
\ingroup examples-qtscxml
- \brief Demonstrates how to send/receive data to/from EcmaScript data-model.
+ \brief A Qt Quick application that sends data to and receives it from a
+ compiled ECMAScript data model.
+
+ \image mediaplayer.png
+
+ \e {Media Player QML Example (Static)} demonstrates how to access data from
+ an ECMAScript data model that is compiled into a C++ class.
+
+ The UI is created using Qt Quick.
+
+ \include examples-run.qdocinc
+
+ \include mediaplayer-ecmascript-data-model.qdocinc
+
+ \include mediaplayer-compiling.qdocinc
+
+ \section1 Instantiating the State Machine
+
+ We instantiate the generated \c MediaPlayerStateMachine class in
+ \e mediaplayer-qml-static.cpp:
+
+ \quotefromfile mediaplayer-qml-static/mediaplayer-qml-static.cpp
+ \skipto mediaplayer.h
+ \printuntil }
*/