summaryrefslogtreecommitdiffstats
path: root/examples/statemachine/doc/src/factorial.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/statemachine/doc/src/factorial.qdoc')
-rw-r--r--examples/statemachine/doc/src/factorial.qdoc62
1 files changed, 0 insertions, 62 deletions
diff --git a/examples/statemachine/doc/src/factorial.qdoc b/examples/statemachine/doc/src/factorial.qdoc
deleted file mode 100644
index 2a22229..0000000
--- a/examples/statemachine/doc/src/factorial.qdoc
+++ /dev/null
@@ -1,62 +0,0 @@
-// Copyright (C) 2016 The Qt Company Ltd.
-// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
-
-/*!
- \example statemachine/factorial
- \title Factorial States Example
- \ingroup examples-qtstatemachine
-
- \brief The Factorial States example shows how to use \l{Qt State Machine Overview}
- to calculate the factorial of an integer.
-
- The statechart for calculating the factorial looks as follows:
-
- \image factorial-example.png
-
- In other words, the state machine calculates the factorial of 6 and prints
- the result.
-
- \snippet statemachine/factorial/main.cpp 0
-
- The Factorial class is used to hold the data of the computation, \c x and
- \c fac. It also provides a signal that's emitted whenever the value of \c
- x changes.
-
- \snippet statemachine/factorial/main.cpp 1
-
- The FactorialLoopTransition class implements the guard (\c x > 1) and
- calculations (\c fac = \c x * \c fac; \c x = \c x - 1) of the factorial
- loop.
-
- \snippet statemachine/factorial/main.cpp 2
-
- The FactorialDoneTransition class implements the guard (\c x <= 1) that
- terminates the factorial computation. It also prints the final result to
- standard output.
-
- \snippet statemachine/factorial/main.cpp 3
-
- The application's main() function first creates the application object, a
- Factorial object and a state machine.
-
- \snippet statemachine/factorial/main.cpp 4
-
- The \c compute state is created, and the initial values of \c x and \c fac
- are defined. A FactorialLoopTransition object is created and added to the
- state.
-
- \snippet statemachine/factorial/main.cpp 5
-
- A final state, \c done, is created, and a FactorialDoneTransition object
- is created with \c done as its target state. The transition is then added
- to the \c compute state.
-
- \snippet statemachine/factorial/main.cpp 6
-
- The machine's initial state is set to be the \c compute state. We connect
- the QStateMachine::finished() signal to the QCoreApplication::quit() slot,
- so the application will quit when the state machine's work is
- done. Finally, the state machine is started, and the application's event
- loop is entered.
-
- */