Doc: Add docs for the InvokedServices QML type

Change-Id: I87279e065b7ea3ca7bcd9100bc2d36a5e5b677c9
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>

1 files changed, 33 insertions, 0 deletions

diff --git a/src/imports/scxmlstatemachine/invokedservices.cpp b/src/imports/scxmlstatemachine/invokedservices.cpp
index 93c97d6..8d3accf 100644
--- a/src/imports/scxmlstatemachine/invokedservices.cpp
+++ b/src/imports/scxmlstatemachine/invokedservices.cpp
@@ -42,10 +42,31 @@
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    \qmltype InvokedServices
+    \instantiates QScxmlInvokedServices
+    \inqmlmodule QtScxml
+    \since QtScxml 5.8
+
+    \brief Provices access to the services invoked by state machines.
+
+    Makes the invoked services easily accessible by their names, without
+    constantly iterating through QScxmlStateMachine::invokedServices.
+
+    The services are called from state machines via the mechanism described in
+    \l{SCXML Specification - 6.4 <invoke>}.
+*/
+
 QScxmlInvokedServices::QScxmlInvokedServices(QObject *parent) : QObject(parent)
 {
 }
 
+/*!
+    \qmlproperty var InvokedServices::children
+
+    The services invoked by the state machine.
+*/
+
 QVariantMap QScxmlInvokedServices::children()
 {
     QVariantMap ret;
@@ -61,6 +82,12 @@ void QScxmlInvokedServices::classBegin()
 {
 }
 
+/*!
+    \qmlproperty QtObject InvokedServices::stateMachine
+
+    The state machine that invoked the services.
+*/
+
 QScxmlStateMachine *QScxmlInvokedServices::stateMachine() const
 {
     return m_stateMachine;
@@ -81,6 +108,12 @@ void QScxmlInvokedServices::setStateMachine(QScxmlStateMachine *stateMachine)
     }
 }
 
+/*!
+    \qmlproperty list<QtObject> InvokedServices::qmlChildren
+
+    A list of additional QtObject types nested in this type.
+*/
+
 QQmlListProperty<QObject> QScxmlInvokedServices::qmlChildren()
 {
     return QQmlListProperty<QObject>(this, m_qmlChildren);