summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-03-23 12:07:40 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-03-23 12:37:24 +0000
commit06ee5829c54e1aafeb03d387a8f5d6377a7ed115 (patch)
tree464470bdb3995b604904d9096cb33b2df3456f02
parentb2266c013c7eaabe36d7a3c22ee375062f5fffb1 (diff)
Doc: Fix QML property types and method signaturesv5.9.0-beta1
Change-Id: I2b7897015a743cf70847270117ada881559ce7c9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
-rw-r--r--src/imports/scxmlstatemachine/eventconnection.cpp8
-rw-r--r--src/imports/scxmlstatemachine/invokedservices.cpp2
-rw-r--r--src/imports/scxmlstatemachine/statemachineloader.cpp4
-rw-r--r--src/scxml/qscxmlstatemachine.cpp11
4 files changed, 16 insertions, 9 deletions
diff --git a/src/imports/scxmlstatemachine/eventconnection.cpp b/src/imports/scxmlstatemachine/eventconnection.cpp
index c35d43c..2a073bd 100644
--- a/src/imports/scxmlstatemachine/eventconnection.cpp
+++ b/src/imports/scxmlstatemachine/eventconnection.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlproperty QStringList EventConnection::events
+ \qmlproperty stringlist EventConnection::events
The list of SCXML event specifiers that describe the events to listen for.
@@ -64,17 +64,19 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlproperty QScxmlStateMachine EventConnection::stateMachine
+ \qmlproperty ScxmlStateMachine EventConnection::stateMachine
The state machine that sends out the event.
*/
/*!
- \qmlsignal EventConnection::occurred(QScxmlEvent event)
+ \qmlsignal EventConnection::occurred(event)
This signal is emitted when the event \a event occurrs.
The corresponding signal handler is \c onOccurred.
+
+ \sa QScxmlEvent
*/
diff --git a/src/imports/scxmlstatemachine/invokedservices.cpp b/src/imports/scxmlstatemachine/invokedservices.cpp
index 8d3accf..6011557 100644
--- a/src/imports/scxmlstatemachine/invokedservices.cpp
+++ b/src/imports/scxmlstatemachine/invokedservices.cpp
@@ -83,7 +83,7 @@ void QScxmlInvokedServices::classBegin()
}
/*!
- \qmlproperty QtObject InvokedServices::stateMachine
+ \qmlproperty ScxmlStateMachine InvokedServices::stateMachine
The state machine that invoked the services.
*/
diff --git a/src/imports/scxmlstatemachine/statemachineloader.cpp b/src/imports/scxmlstatemachine/statemachineloader.cpp
index 02b23f5..946988f 100644
--- a/src/imports/scxmlstatemachine/statemachineloader.cpp
+++ b/src/imports/scxmlstatemachine/statemachineloader.cpp
@@ -65,7 +65,7 @@ QScxmlStateMachineLoader::QScxmlStateMachineLoader(QObject *parent)
}
/*!
- \qmlproperty QObject StateMachineLoader::stateMachine
+ \qmlproperty ScxmlStateMachine StateMachineLoader::stateMachine
The state machine instance.
*/
@@ -75,7 +75,7 @@ QT_PREPEND_NAMESPACE(QScxmlStateMachine) *QScxmlStateMachineLoader::stateMachine
}
/*!
- \qmlproperty string StateMachineLoader::source
+ \qmlproperty url StateMachineLoader::source
The URL of the SCXML document to load. Only synchronously accessible URLs
are supported.
diff --git a/src/scxml/qscxmlstatemachine.cpp b/src/scxml/qscxmlstatemachine.cpp
index 4b6f3d8..13158f7 100644
--- a/src/scxml/qscxmlstatemachine.cpp
+++ b/src/scxml/qscxmlstatemachine.cpp
@@ -1520,7 +1520,7 @@ QScxmlStateMachine::QScxmlStateMachine(QScxmlStateMachinePrivate &dd, QObject *p
*/
/*!
- \qmlproperty QScxmlStateMachine ScxmlStateMachine::dataModel
+ \qmlproperty ScxmlDataModel ScxmlStateMachine::dataModel
The data model to be used for this state machine.
@@ -1530,6 +1530,9 @@ QScxmlStateMachine::QScxmlStateMachine(QScxmlStateMachinePrivate &dd, QObject *p
Changing the data model when the state machine has been \l initialized is
not specified in the SCXML standard and leads to undefined behavior.
+
+ \sa QScxmlDataModel, QScxmlNullDataModel, QScxmlEcmaScriptDataModel,
+ QScxmlCppDataModel
*/
/*!
@@ -1628,7 +1631,7 @@ QScxmlStateMachine::QScxmlStateMachine(QScxmlStateMachinePrivate &dd, QObject *p
*/
/*!
- \qmlproperty list ScxmlStateMachine::parseErrors
+ \qmlproperty var ScxmlStateMachine::parseErrors
The list of parse errors that occurred while creating a state machine from
an SCXML file.
@@ -2024,7 +2027,7 @@ QString QScxmlStateMachine::name() const
}
/*!
- \qmlmethod ScxmlStateMachine::submitEvent(QScxmlEvent event)
+ \qmlmethod ScxmlStateMachine::submitEvent(event)
Submits the SCXML event \a event to the internal or external event queue
depending on the priority of the event.
@@ -2032,6 +2035,8 @@ QString QScxmlStateMachine::name() const
When a delay is set, the event will be queued for delivery after the timeout
has passed. The state machine takes ownership of the event and deletes it
after processing.
+
+ \sa QScxmlEvent
*/
/*!