diff options
| author | Tamas Martinec <tamas.martinec@symbio.com> | 2021-03-19 15:05:31 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-03-23 15:38:29 +0000 |
| commit | 69e315718fe4975790dd1753392a0f16fe2c8473 (patch) | |
| tree | 4145edb76a3a1c47208470334f6f8e1f9ed7191b /examples | |
| parent | bc755ef2113caaf4ccbe85d4f891a26d29b8c698 (diff) | |
Improve the documentation of the two way button example
Also fix for the "Example documentation should have at
least one '\image'" qdoc warning.
Task-number: QTBUG-89834
Change-Id: I271632c1c1851318939049a6c2832e75cac3d0c0
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit 3f5d1807eaa8601a5812b01657f1ed4837ff6ec3)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/statemachine/doc/images/twowaybutton-chart.png | bin | 0 -> 11001 bytes | |||
| -rw-r--r-- | examples/statemachine/doc/images/twowaybutton-example.png | bin | 0 -> 2361 bytes | |||
| -rw-r--r-- | examples/statemachine/doc/src/twowaybutton.qdoc | 4 |
3 files changed, 4 insertions, 0 deletions
diff --git a/examples/statemachine/doc/images/twowaybutton-chart.png b/examples/statemachine/doc/images/twowaybutton-chart.png Binary files differnew file mode 100644 index 0000000..521b9e2 --- /dev/null +++ b/examples/statemachine/doc/images/twowaybutton-chart.png diff --git a/examples/statemachine/doc/images/twowaybutton-example.png b/examples/statemachine/doc/images/twowaybutton-example.png Binary files differnew file mode 100644 index 0000000..a5457f8 --- /dev/null +++ b/examples/statemachine/doc/images/twowaybutton-example.png diff --git a/examples/statemachine/doc/src/twowaybutton.qdoc b/examples/statemachine/doc/src/twowaybutton.qdoc index 6e4eed9..a51cda4 100644 --- a/examples/statemachine/doc/src/twowaybutton.qdoc +++ b/examples/statemachine/doc/src/twowaybutton.qdoc @@ -35,6 +35,8 @@ to implement a simple state machine that toggles the current state when a button is clicked. + \image twowaybutton-example.png + \snippet statemachine/twowaybutton/main.cpp 0 The application's main() function begins by constructing the application @@ -42,6 +44,8 @@ \snippet statemachine/twowaybutton/main.cpp 1 + \image twowaybutton-chart.png + The state machine has two states; \c on and \c off. When either state is entered, the text of the button will be set accordingly. |
