From 9c8577c12643bf222dc37a5ba2dc1d08dc168f8e Mon Sep 17 00:00:00 2001 From: Dmitrii Akshintsev Date: Mon, 15 Apr 2024 16:36:13 +0200 Subject: Add a note about QScxmlStateMachine restart As part of QTBUG-109371 it was discovered that calling start() after stop() doesn't result in a "clean" initial step which is contorary to the existing documentation. It was agreed that ATM changing documentation to better reflect the current state is more suitable, than doing a proper "clean". This commit addresses the documentation issue Fixes: QTBUG-109371 Change-Id: Iaec8f31b39873a1cdc2809e5773fcaa1e6f5d37c Reviewed-by: Ulf Hermann --- src/scxml/qscxmlstatemachine.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/scxml/qscxmlstatemachine.cpp b/src/scxml/qscxmlstatemachine.cpp index 1ccd37d..71d35b3 100644 --- a/src/scxml/qscxmlstatemachine.cpp +++ b/src/scxml/qscxmlstatemachine.cpp @@ -2252,14 +2252,16 @@ QBindable> QScxmlStateMachine::bindableInvokedSer */ /*! - Starts this state machine. The machine will reset its configuration and - transition to the initial state. When a final top-level state + Starts this state machine. When a final top-level state is entered, the machine will emit the finished() signal. \note A state machine will not run without a running event loop, such as the main application event loop started with QCoreApplication::exec() or QApplication::exec(). + \note Calling start() after stop() will not result in a full reset of its + configuration yet, hence it is strongly advised not to do it. + \sa runningChanged(), setRunning(), stop(), finished() */ void QScxmlStateMachine::start() -- cgit v1.2.3