summaryrefslogtreecommitdiffstats
path: root/examples/scxml/calculator-common
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2016-04-01 10:45:41 +0200
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2016-04-01 10:54:11 +0000
commitdb0267082c31e82b7079819efcfa1782b52f4f4f (patch)
tree0fd2d37227b2e125e5bff9b3eaaa0140ddf74f41 /examples/scxml/calculator-common
parent4deeb7ac30a3a5423fb8063e1b2c835bd50f018b (diff)
Doc: Add docs for Calculator QML example
- Use a .qdocinc include file for compilation instructions - Add screenshot - Fix related issues in the widget version docs Change-Id: Ia1de27f81a45e23ab37158cb66b537c95810c28b Reviewed-by: Ulf Hermann <ulf.hermann@theqtcompany.com>
Diffstat (limited to 'examples/scxml/calculator-common')
-rw-r--r--examples/scxml/calculator-common/doc/src/calculator-compiling.qdocinc19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/scxml/calculator-common/doc/src/calculator-compiling.qdocinc b/examples/scxml/calculator-common/doc/src/calculator-compiling.qdocinc
new file mode 100644
index 0000000..54fe26b
--- /dev/null
+++ b/examples/scxml/calculator-common/doc/src/calculator-compiling.qdocinc
@@ -0,0 +1,19 @@
+ \section1 Compiling the State Machine
+
+ We link against the Qt SCXML module by adding the following line to the
+ \e .pro file:
+
+ \quotefromfile calculator-widgets/calculator-widgets.pro
+ \printuntil scxml
+
+ We then specify the state machine to compile:
+
+ \skipto STATECHARTS
+ \printline calculator
+
+ We also tell qmake to run \c qscxmlc, which generates \e statemachine.h and
+ \e statemachine.cpp, and adds them to the \c HEADERS and \c SOURCES
+ variables for compilation:
+
+ \skipto load
+ \printline qscxmlc