diff options
| author | Juha Vuolle <juha.vuolle@insta.fi> | 2021-02-04 13:22:16 +0200 |
|---|---|---|
| committer | Juha Vuolle <juha.vuolle@insta.fi> | 2021-02-11 09:10:48 +0200 |
| commit | 84c7967a6c9fc13b2e588b029030546fa6f8b92e (patch) | |
| tree | 0aced5e1a961550af1461e33f5b3925c048ed584 /tools | |
| parent | 72841fe10402148de78c218d06bf1a1f3d3857d0 (diff) | |
Qt6 related documentation changes for scxml module
Some perhaps less-obvious changes are:
-Remove nonexistent imagedirs reference in qdocconf
-Address some qdoc warnings (“/“ usage in an example and also
std::function handling)
-Fix ftpclient example filename references
-Mark an escaped Q_OBJECT usage as badcode to suppress qdoc warning
The Q_OBJECT itself cannot be unescaped as automoc will then fail.
It shouldn't but that is the case.
-Change the examples’ CMakeLists.txt to use single-line find_packages
to ensure packages are not mixed and matched. Probability for problems
is low but perhaps since these are examples that is appropriate
Pick-to: 6.1
Task-number: QTBUG-89833
Change-Id: Ibf518aa71971e8e9d0af1b49c7de86fd28089e96
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/qscxmlc/doc/qscxmlc.qdoc | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/tools/qscxmlc/doc/qscxmlc.qdoc b/tools/qscxmlc/doc/qscxmlc.qdoc index bf38a63..20c9c6b 100644 --- a/tools/qscxmlc/doc/qscxmlc.qdoc +++ b/tools/qscxmlc/doc/qscxmlc.qdoc @@ -39,18 +39,23 @@ \section1 Usage - The \c qscxml tool is invoked automatically if the QT variable in the - project file includes \c scxml, and the .scxml file to use is specified - using the \c STATECHARTS variable. + The \c qscxmlc tool is invoked automatically if the project is linked against + the \c scxml library in the project file, and the \c .scxml file to use is specified + using the special build directives \c STATECHARTS or qt6_add_statecharts. - \badcode - QT += scxml - STATECHARTS = MyStatemachine.scxml - \endcode + When using cmake: - With above definitions, \c qmake invokes \c qscxmlc to generate - MyStatemachine.h and MyStatemachine.cpp, and adds them to \l [QMake] - HEADERS and \l [QMAKE] SOURCES variables. + \include qtscxml-module-use.qdocinc cmakebuild + \include qtscxml-module-use.qdocinc cmakestatecharts + + When using qmake: + + \include qtscxml-module-use.qdocinc qmakebuild + \include qtscxml-module-use.qdocinc qmakestatecharts + + With above definitions, \c qmake or \c cmake invokes \c qscxmlc to generate + MyStatemachine.h and MyStatemachine.cpp, and adds them appropriately + to the project as headers and sources. By default, the name of the generated class that implements the state machine corresponds with the \e name attribute of the \c <scxml> root |