diff options
author | Venu <venugopal.shivashankar@digia.com> | 2014-09-24 17:11:11 +0200 |
---|---|---|
committer | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2014-10-09 15:52:59 +0200 |
commit | 9413d62f6120c8be509bb46adf75ce302550e0b3 (patch) | |
tree | 488f12dd72f45bf852d3ead65e7bf9d982de7d98 /src/imports | |
parent | f5e098e428855925382d25c84f14db4dbf773411 (diff) |
Doc: Updated the QML State Machine docs
- Excluded the src/imports/statemachine directory from
qtquick.qdocconf to avoid unnecessary qdoc warnings.
- corrected a broken link to an external source
- changed the group name to avoid collision
- added a \qmlmodule page for QtQml.StateMachine
- Reduced the amount of duplication between the
C++ and QML state machine overviews.
Task-number: QTBUG-41561
Change-Id: I87c815fada7006f0609331e315bb338f062bb4db
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/imports')
-rw-r--r-- | src/imports/statemachine/finalstate.cpp | 4 | ||||
-rw-r--r-- | src/imports/statemachine/signaltransition.cpp | 16 | ||||
-rw-r--r-- | src/imports/statemachine/statebase.cpp | 14 | ||||
-rw-r--r-- | src/imports/statemachine/statemachine.cpp | 4 | ||||
-rw-r--r-- | src/imports/statemachine/timeouttransition.cpp | 4 |
5 files changed, 24 insertions, 18 deletions
diff --git a/src/imports/statemachine/finalstate.cpp b/src/imports/statemachine/finalstate.cpp index b530229389..73e85a1abd 100644 --- a/src/imports/statemachine/finalstate.cpp +++ b/src/imports/statemachine/finalstate.cpp @@ -49,9 +49,9 @@ QQmlListProperty<QObject> FinalState::children() /*! \qmltype FinalState - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QAbstractState - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief Provides a final state. diff --git a/src/imports/statemachine/signaltransition.cpp b/src/imports/statemachine/signaltransition.cpp index 634ec5a43b..eb842914a1 100644 --- a/src/imports/statemachine/signaltransition.cpp +++ b/src/imports/statemachine/signaltransition.cpp @@ -126,8 +126,10 @@ void SignalTransition::invoke() /*! \qmltype QAbstractTransition - \inqmlmodule QtStateMachine 1.0 - \ingroup qmlstatemachine + \inqmlmodule QtQml.StateMachine + \omit + \ingroup statemachine-qmltypes + \endomit \since 5.4 \brief The QAbstractTransition type is the base type of transitions between QAbstractState objects. @@ -184,9 +186,11 @@ void SignalTransition::invoke() /*! \qmltype QSignalTransition - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QAbstractTransition - \ingroup qmlstatemachine + \omit + \ingroup statemachine-qmltypes + \endomit \since 5.4 \brief The QSignalTransition type provides a transition based on a Qt signal. @@ -212,9 +216,9 @@ void SignalTransition::invoke() /*! \qmltype SignalTransition - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QSignalTransition - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief The SignalTransition type provides a transition based on a Qt signal. diff --git a/src/imports/statemachine/statebase.cpp b/src/imports/statemachine/statebase.cpp index ec0fe217b5..d33e294369 100644 --- a/src/imports/statemachine/statebase.cpp +++ b/src/imports/statemachine/statebase.cpp @@ -60,8 +60,10 @@ QQmlListProperty<QObject> StateBase::children() /*! \qmltype QAbstractState - \inqmlmodule QtStateMachine 1.0 - \ingroup qmlstatemachine + \inqmlmodule QtQml.StateMachine + \omit + \ingroup statemachine-qmltypes + \endomit \since 5.4 \brief The QAbstractState type is the base type of States of a StateMachine. @@ -104,9 +106,9 @@ QQmlListProperty<QObject> StateBase::children() /*! \qmltype StateBase - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QAbstractState - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief Provides a general-purpose state for StateMachine. @@ -177,9 +179,9 @@ QQmlListProperty<QObject> StateBase::children() /*! \qmltype HistoryState - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QAbstractState - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief The HistoryState type provides a means of returning to a previously active substate. diff --git a/src/imports/statemachine/statemachine.cpp b/src/imports/statemachine/statemachine.cpp index 6c92edd65f..c65901a175 100644 --- a/src/imports/statemachine/statemachine.cpp +++ b/src/imports/statemachine/statemachine.cpp @@ -79,9 +79,9 @@ QQmlListProperty<QObject> StateMachine::children() /*! \qmltype StateMachine - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits StateBase - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief Provides a hierarchical finite state machine. diff --git a/src/imports/statemachine/timeouttransition.cpp b/src/imports/statemachine/timeouttransition.cpp index 3709a385a7..fdfb70eaab 100644 --- a/src/imports/statemachine/timeouttransition.cpp +++ b/src/imports/statemachine/timeouttransition.cpp @@ -78,9 +78,9 @@ void TimeoutTransition::componentComplete() /*! \qmltype TimeoutTransition - \inqmlmodule QtStateMachine 1.0 + \inqmlmodule QtQml.StateMachine \inherits QSignalTransition - \ingroup qmlstatemachine + \ingroup statemachine-qmltypes \since 5.4 \brief The TimeoutTransition type provides a transition based on a timer. |