summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNoam Rosenthal <nrosenth@nokia.com>2009-06-08 12:52:57 -0700
committerNoam Rosenthal <nrosenth@nokia.com>2009-06-08 12:52:57 -0700
commitd06fc6db2bf3ec9fd63923dfc0bccc992ccf3f44 (patch)
treedad1d853d8b7cdd40915f6fee80dce7160088cef /src
parent7a41ce5b7a595c67c16ae5ef1711927623602b6a (diff)
Documentation fixes
Diffstat (limited to 'src')
-rw-r--r--src/qscxml.cpp22
1 files changed, 15 insertions, 7 deletions
diff --git a/src/qscxml.cpp b/src/qscxml.cpp
index 0651ade..675a0ae 100644
--- a/src/qscxml.cpp
+++ b/src/qscxml.cpp
@@ -40,12 +40,9 @@
****************************************************************************/
/*!
\class QScxml
- \reentrant
\brief The QScxml class provides a way to use scripting with the Qt State Machine Framework.
- \ingroup sctools
-
Though can be used alone, QScxml is mainly a runtime helper to using the
state-machine framework with SCXML files.
@@ -352,7 +349,6 @@ static QScriptValue isInState(QScriptContext *context, QScriptEngine *engine)
Encapsulates an event that conforms to the SCXML definition of events.
- \ingroup sctools
*/
/*! \enum QScxmlEvent::MetaData::Kind
@@ -421,8 +417,18 @@ QScxmlEvent::QScxmlEvent(
\brief The QScxmlTransition class stands for a transition that responds to QScxmlEvent, and can be made conditional with a \l conditionExpression.
Equivalent to the SCXML transition tag.
- \ingroup sctools
*/
+
+/*!
+\fn QScxmlTransition::onTransition(QEvent* e)
+Reimplements onTransition with even \a e, to activate the transition signal.
+*/
+ /*!
+\fn QScxmlTransition::activated()
+Emitted when the transition is activated, after exiting the old states before entering the new states.
+*/
+
+
/*! \property QScxmlTransition::eventPrefix
The event prefix to be used when testing if the transition needs to be invoked.
Uses SCXML prefix matching. Use * to handle any event.
@@ -591,6 +597,7 @@ class QScxmlBindingInvoker : public QScxmlInvoker
}
}
};
+
/*!
\fn QScxmlInvoker::~QScxmlInvoker()
@@ -790,7 +797,6 @@ void QScxml::registerInvokerFactory (QScxmlInvokerFactory* f)
\brief The QScxmlInvoker class an invoker, which the state-machine context can activate or cancel
with an <invoke> tag.
- \ingroup sctools
An invoker is a object that represents an external component that the state machine
can activate when the encompassing state is entered, or cancel when the encompassing
@@ -846,7 +852,9 @@ QScxml::~QScxml()
{
delete pvt;
}
-
+/*!
+returns the id for this invoker
+*/
QString QScxmlInvoker::id () const
{
return initEvent->metaData.invokeID;