diff options
author | Kent Hansen <khansen@trolltech.com> | 2009-05-05 19:45:06 +0200 |
---|---|---|
committer | Kent Hansen <khansen@trolltech.com> | 2009-05-05 19:45:06 +0200 |
commit | 7700ecce8cb3b64e1ef8c4804022ceda2bed24c9 (patch) | |
tree | b545d35d7b7e297e7fc9c0d91b38d23f88de3bd2 /src/corelib/statemachine/qfinalstate.cpp | |
parent | b8a4216f2fb5bc6e5fd5b54c661344e60fc9093c (diff) |
doc improvements
Diffstat (limited to 'src/corelib/statemachine/qfinalstate.cpp')
-rw-r--r-- | src/corelib/statemachine/qfinalstate.cpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/corelib/statemachine/qfinalstate.cpp b/src/corelib/statemachine/qfinalstate.cpp index 772ec87ff3..0980336c9f 100644 --- a/src/corelib/statemachine/qfinalstate.cpp +++ b/src/corelib/statemachine/qfinalstate.cpp @@ -55,9 +55,9 @@ QT_BEGIN_NAMESPACE A final state is used to communicate that (part of) a QStateMachine has finished its work. When a final top-level state is entered, the state machine's \l{QStateMachine::finished()}{finished}() signal is emitted. In - general, when a final substate (a child of a QState) is entered, a - QStateFinishedEvent is generated for the final state's parent - state. QFinalState is part of \l{The State Machine Framework}. + general, when a final substate (a child of a QState) is entered, the parent + state's \l{QState::finished()}{finished}() signal is emitted. QFinalState + is part of \l{The State Machine Framework}. To use a final state, you create a QFinalState object and add a transition to it from another state. Example: @@ -76,6 +76,8 @@ QT_BEGIN_NAMESPACE machine.setInitialState(s1); machine.start(); \endcode + + \sa QStateMachine::finished(), QState::finished() */ class QFinalStatePrivate : public QAbstractStatePrivate |