diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-23 13:15:25 +0100 |
---|---|---|
committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-28 10:41:07 +0000 |
commit | 7dea21dc435ef44e3c84254721ddbf85c6ab0917 (patch) | |
tree | d0d2ace295bc7e5a3adfd1fa08f632d8bc20a19d | |
parent | 3ee7e096064899eee469d3e56a460925cc9354df (diff) |
Doc: Revise Qt State Machine module landing page
Use the global CMake and qmake snippets.
Task-number: QTBUG-100369
Pick-to: 6.3 6.3.0
Change-Id: I6f877e30c10e736db947903705163a5bcf460fb7
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r-- | src/statemachine/doc/qtstatemachine-index.qdoc | 25 |
1 files changed, 10 insertions, 15 deletions
diff --git a/src/statemachine/doc/qtstatemachine-index.qdoc b/src/statemachine/doc/qtstatemachine-index.qdoc index c5706c1..489e13f 100644 --- a/src/statemachine/doc/qtstatemachine-index.qdoc +++ b/src/statemachine/doc/qtstatemachine-index.qdoc @@ -33,28 +33,23 @@ The State Machine framework provides classes for creating and executing state graphs. - \section1 Getting Started + \section1 Using the Module - To include the definitions of the module's classes, use the following directive: + \section2 QML API - \code - #include <QStateMachine> - \endcode + \include {module-use.qdocinc} {using the qml api} {QtQml.StateMachine} - To import the QML types into your application, use the following import statement - in your .qml file: + \section2 C++ API - \qml - import QtQml.StateMachine - \endqml + \include {module-use.qdocinc} {using the c++ api} - To link against the module: + \section3 Building with CMake - When using CMake add to \e CMakeLists.txt: - \include qtstatemachine-module-use.qdocinc cmakebuild + \include {module-use.qdocinc} {building with cmake} {StateMachine} - When using qmake add to the project \e .pro file: - \include qtstatemachine-module-use.qdocinc qmakebuild + \section3 Building with qmake + + \include {module-use.qdocinc} {building with cmake} {statemachine} \section1 Articles and Guides |