diff options
| author | Sami Shalayel <sami.shalayel@qt.io> | 2023-09-25 10:16:21 +0200 |
|---|---|---|
| committer | Sami Shalayel <sami.shalayel@qt.io> | 2023-10-18 17:49:01 +0200 |
| commit | f9eabe862b4cf7183a024151b0ad8c62fa7a5090 (patch) | |
| tree | ffdc186daf24cbc628ece00ea390f4061f301d28 /src/qml/doc | |
| parent | 16023fc77c423a267fcc48894ff942e94cf35b86 (diff) | |
doc: qt_add_qml_module links to qmltc's doc about private headers
Add a note in qt_add_qml_module that qmltc requires private headers in
the ENABLE_TYPE_COMPILER section, and link to the part of the
documentation of qmltc that explains how to compile QML to C++ using
CMake.
Fixes: QTBUG-117451
Pick-to: 6.5 6.6
Change-Id: Ie5e6e6c92a10ef4822e5a712bb31e06bdce6bf5e
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/cmake/qt_add_qml_module.qdoc | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc index 908dc511d6..f0dc239f94 100644 --- a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc +++ b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc @@ -338,6 +338,14 @@ how to set the \c QT_QML_SINGLETON_TYPE property. \target qmltc-cmake \section2 Compiling QML to C++ with QML type compiler +\note The \l{QML type compiler} \c{qmltc} does not guarantee that the generated +C++ stays API-, source- or binary-compatible between past or future versions, +even patch versions. +Furthermore, qmltc-compiled apps using Qt's QML modules will require linking +against private Qt API, see also +\l{QML type compiler#compiling-qml-code-with-qmltc}{Compiling QML code with qmltc}. + + If a QML module has \c{.qml} files, you can compile them to C++ using \l{QML type compiler}{qmltc}. Unlike \l{qmlcachegen-auto}{bytecode compilation}, you have to explicitly enable qmltc via \l{ENABLE_TYPE_COMPILER} argument. In which |