summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@insta.fi>2021-04-01 12:07:42 +0300
committerJuha Vuolle <juha.vuolle@insta.fi>2021-04-19 14:35:03 +0300
commitbcc71d9710908311545e0da37eeb645e3221455d (patch)
tree1625c04c269e23f191f4921be50b6fb96abd01a0 /tools
parent0d8a1d4d68a23bebcfdaab931d030fc8b46145f5 (diff)
qt6_add_statecharts cmake macro documentation
The aim is to include the macro to Qt6 cmake command reference. The commit also improves the macro's documentation which was a bit of a mix-and-match and not fully documented in the central location. Pick-to: 6.1 Task-number: QTBUG-82460 Change-Id: Ia9cfa50df5af9872779d015894e914a7d45bb8c1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tools')
-rw-r--r--tools/qscxmlc/doc/qscxmlc.qdoc20
1 files changed, 18 insertions, 2 deletions
diff --git a/tools/qscxmlc/doc/qscxmlc.qdoc b/tools/qscxmlc/doc/qscxmlc.qdoc
index c878a1d..2372440 100644
--- a/tools/qscxmlc/doc/qscxmlc.qdoc
+++ b/tools/qscxmlc/doc/qscxmlc.qdoc
@@ -82,8 +82,7 @@
\li Description
\row
\li \c {--namespace <namespace>}
- \li Put the generated class(es) in the specified namespace. You can use the
- \c QSCXMLC_NAMESPACE variable to specify this in your project file.
+ \li Put the generated class(es) in the specified namespace.
\row
\li \c {-o <base/out/name>}
\li The base name of the output files. This can include a path. If none is specified, the
@@ -105,4 +104,21 @@
state changes with plain QObject::connect() and directly call a method to find out if
a state is currently active.
\endtable
+
+ In addition to \c QSCXMLC_ARGUMENTS options, the \c qmake and \c CMake project files support
+ the following options:
+
+ \table
+ \header
+ \li Option
+ \li Description
+ \row
+ \li \c {QSCXMLC_DIR|OUTPUT_DIR <directory>}
+ \li \c QSCXMLC_DIR (qmake) or \c OUTPUT_DIR (cmake) specifies the directory for the output
+ files.
+ \row
+ \li \c {QSCXMLC_NAMESPACE|NAMESPACE <namespace>}
+ \li \c QSCXMLC_NAMESPACE (qmake) or \c NAMESPACE (cmake) specifies the namespace for the
+ generated classes.
+ \endtable
*/