diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2016-03-09 16:59:06 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2016-03-15 15:01:14 +0000 |
| commit | 93ba677a1c1661710a8a6e20140858ef238eda21 (patch) | |
| tree | 4adb539717ad645ff517aecd23d201d34910665b /examples/scxml/mediaplayer-common | |
| parent | 7d0c11c64f61d5ef6e5bd6513ddd6387bb6ae92e (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-common')
4 files changed, 44 insertions, 0 deletions
diff --git a/examples/scxml/mediaplayer-common/doc/images/mediaplayer.png b/examples/scxml/mediaplayer-common/doc/images/mediaplayer.png Binary files differnew file mode 100644 index 0000000..9c32b78 --- /dev/null +++ b/examples/scxml/mediaplayer-common/doc/images/mediaplayer.png diff --git a/examples/scxml/mediaplayer-common/doc/src/mediaplayer-compiling.qdocinc b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-compiling.qdocinc new file mode 100644 index 0000000..d4eb6ee --- /dev/null +++ b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-compiling.qdocinc @@ -0,0 +1,20 @@ + \section1 Compiling the State Machine + + We link against the Qt SCXML module by adding the following line to the + \e .pro file: + + \quotefromfile mediaplayer-widgets-static/mediaplayer-widgets-static.pro + \skipto QT + \printline scxml + + We then specify the state machine to compile: + + \skipto STATECHARTS + \printline scxml + + We also tell qmake to run \c qscxmlc, which generates \e mediaplayer.h and + \e mediaplayer.cpp, and adds them to the \c HEADERS and \c SOURCES + variables for compilation: + + \skipto load + \printline qscxmlc diff --git a/examples/scxml/mediaplayer-common/doc/src/mediaplayer-dynamic.qdocinc b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-dynamic.qdocinc new file mode 100644 index 0000000..e9ae43b --- /dev/null +++ b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-dynamic.qdocinc @@ -0,0 +1,15 @@ + \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 mediaplayer-qml-dynamic/mediaplayer-qml-dynamic.pro + \skipto QT + \printline scxml + + We dynamically create the state machine in + \e mediaplayer-common\Mediaplayer.qml: + + \quotefromfile mediaplayer-common/Mediaplayer.qml + \skipto import Scxml + \printuntil scxmlLoader.filename diff --git a/examples/scxml/mediaplayer-common/doc/src/mediaplayer-ecmascript-data-model.qdocinc b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-ecmascript-data-model.qdocinc new file mode 100644 index 0000000..31218ef --- /dev/null +++ b/examples/scxml/mediaplayer-common/doc/src/mediaplayer-ecmascript-data-model.qdocinc @@ -0,0 +1,9 @@ + \section1 Using the ECMAScript Data Model + + We specify the data model as a value of the \e datamodel attribute of the + \c <scxml> element in \e mediaplayer-common/mediaplayer.scxml: + + \quotefromfile mediaplayer-common/mediaplayer.scxml + \skipto enable-qt-mode + \printuntil </datamodel> + |
