qmlstatemachine: Rename StateBase to State

As discussed with Brett Stottlmyer and Alan Alpert.

Add a section about the implications when importing both
QtQml.StateMachine
and QtQuick in one single QML file.

Change-Id: I8755f4b578e2a6ff4c2377c7a8a0b996ba9b7129
Reviewed-by: BogDan Vatra <bogdan@kde.org>
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

1 files changed, 8 insertions, 8 deletions

diff --git a/src/imports/statemachine/statemachine.cpp b/src/imports/statemachine/statemachine.cpp
index c65901a175..7b9ebdb88b 100644
--- a/src/imports/statemachine/statemachine.cpp
+++ b/src/imports/statemachine/statemachine.cpp
@@ -80,7 +80,7 @@ QQmlListProperty<QObject> StateMachine::children()
 /*!
     \qmltype StateMachine
     \inqmlmodule QtQml.StateMachine
-    \inherits StateBase
+    \inherits State
     \ingroup statemachine-qmltypes
     \since 5.4
 
@@ -97,7 +97,7 @@ QQmlListProperty<QObject> StateMachine::children()
     algorithm. The framework's \l{The Declarative State Machine Framework}{overview}
     gives several state graphs and the code to build them.
 
-    Before the machine can be started, the \l{StateBase::initialState}{initialState}
+    Before the machine can be started, the \l{State::initialState}{initialState}
     must be set. The initial state is the state that the
     machine enters when started.  You can then set running property to true
     or start() the state machine.  The started signal is emitted when the
@@ -116,7 +116,7 @@ QQmlListProperty<QObject> StateMachine::children()
     \snippet qml/statemachine/simplestatemachine.qml document
 
     If an error is encountered, the machine will look for an
-    \l{StateBase::errorState}{errorState}, and if one is available, it will
+    \l{State::errorState}{errorState}, and if one is available, it will
     enter this state.  After the error state is entered, the type of the error
     can be retrieved with error().  The execution of the state graph will not
     stop when the error state is entered.  If no error state applies to the
@@ -125,7 +125,7 @@ QQmlListProperty<QObject> StateMachine::children()
 
     \clearfloat
 
-    \sa QAbstractState, StateBase, SignalTransition, TimeoutTransition, HistoryState {The Declarative State Machine Framework}
+    \sa QAbstractState, State, SignalTransition, TimeoutTransition, HistoryState {The Declarative State Machine Framework}
 */
 
 /*!
@@ -181,18 +181,18 @@ QQmlListProperty<QObject> StateMachine::children()
     the main application event loop started with QCoreApplication::exec() or
     QApplication::exec().
 
-    \sa started, StateBase::finished, stop(), StateBase::initialState, running
+    \sa started, State::finished, stop(), State::initialState, running
 */
 
 /*!
     \qmlsignal StateMachine::started()
 
     This signal is emitted when the state machine has entered its initial state
-    (StateBase::initialState).
+    (State::initialState).
 
     The corresponding handler is \c onStarted.
 
-    \sa running, start(), StateBase::finished
+    \sa running, start(), State::finished
 */
 
 /*!
@@ -211,5 +211,5 @@ QQmlListProperty<QObject> StateMachine::children()
 
     The corresponding handler is \c onStopped.
 
-    \sa running, stop(), StateBase::finished
+    \sa running, stop(), State::finished
 */