summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2025-12-06 19:15:31 +0100
committerJerome Pasion <jerome.pasion@qt.io>2025-12-09 13:54:24 +0000
commit22112754edbaf5dce79770339b6fbb821a375485 (patch)
treea2bdd9ca21bb43aabc2f12cd06b1a9924f37d714
parente83addebba4b60bc0c46d6e050cb073ca77977b6 (diff)
Doc: Mark internal class documentation as \internalHEADdev
Create class documentation for private classes and mark them internal Class documentation creates a fuller documentation set, even for internal documentation. Task-number: QTBUG-141665 Pick-to: 6.11 Change-Id: I1b992061c45f130e3d5d37f34ee893570886f679 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
-rw-r--r--src/scxml/qscxmlinvokableservice.cpp6
-rw-r--r--src/scxml/qscxmlstatemachine.cpp8
2 files changed, 13 insertions, 1 deletions
diff --git a/src/scxml/qscxmlinvokableservice.cpp b/src/scxml/qscxmlinvokableservice.cpp
index 0665406..8845d51 100644
--- a/src/scxml/qscxmlinvokableservice.cpp
+++ b/src/scxml/qscxmlinvokableservice.cpp
@@ -287,6 +287,12 @@ QScxmlScxmlService::~QScxmlScxmlService()
}
/*!
+ \class QScxmlScxmlService
+ \inmodule QtScxml
+ \internal
+*/
+
+/*!
Creates a SCXML service wrapping \a stateMachine, invoked from
\a parentStateMachine, as a child of \a factory.
*/
diff --git a/src/scxml/qscxmlstatemachine.cpp b/src/scxml/qscxmlstatemachine.cpp
index cb35778..ac8247d 100644
--- a/src/scxml/qscxmlstatemachine.cpp
+++ b/src/scxml/qscxmlstatemachine.cpp
@@ -487,11 +487,17 @@ void QScxmlStateMachinePrivate::submitDelayedEvent(QScxmlEvent *event)
}
/*!
+ \class QScxmlStateMachinePrivate
+ \inmodule QtScxml
+ \internal
+*/
+
+/*!
* Submits an error event to the external event queue of this state machine.
*
* The type of the error is specified by \a type. The value of type has to begin
* with the string \e error. For example \c {error.execution}. The message,
- * \a message, decribes the error and is passed to the event as the
+ * \a message, describes the error and is passed to the event as the
* \c errorMessage property. The \a sendId of the message causing the error is specified, if it has
* one.
*/