diff options
Diffstat (limited to 'src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc')
| -rw-r--r-- | src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc index c92286f109..87125cd0bf 100644 --- a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc +++ b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc @@ -6,17 +6,17 @@ \ingroup cmake-commands-qtqml \title qt_deploy_qml_imports -\target qt6_deploy_qml_imports +\keyword qt6_deploy_qml_imports \summary {Deploy the runtime components of QML modules needed by an executable.} \include cmake-find-package-qml.qdocinc -Unlike most other CMake commands provided by Qt, \c{qt_deploy_qml_imports()} -can only be called from a deployment script. It cannot be called directly by the -project. +Unlike most other CMake commands provided by Qt, +\c{qt6_deploy_qml_imports} can only be called from a +deployment script. It cannot be called directly by the project. -\include cmake-qml-qt-finalize-target-warning.qdocinc +\include cmake-qml-qt-finalize-target-warning.qdocinc warning \section1 Synopsis @@ -38,9 +38,9 @@ qt_deploy_qml_imports( When installing an application that uses QML, it may be non-trivial to work out which QML modules and which parts of those QML modules need to also be installed. Because QML plugins are not linked directly to an application's -executable, \l{qt_deploy_runtime_dependencies()} won't find these QML modules. -The \c{qt_deploy_qml_imports()} command provides the necessary logic which -complements \l{qt_deploy_runtime_dependencies()} and deploys the runtime parts +executable, \l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()} won't find these QML modules. +The \c{qt6_deploy_qml_imports} command provides the necessary logic which +complements \l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()} and deploys the runtime parts of all QML modules imported by the application. The \c{TARGET} option is mandatory and should specify a \c{target} that is an @@ -62,10 +62,11 @@ choice. The command will store a list of all QML plugins it deploys in the variable named by the \c{PLUGINS_FOUND} option, if given. This is often passed as the \c{ADDITIONAL_MODULES} argument in a subsequent call to -\l{qt_deploy_runtime_dependencies()}. +\l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()}. \sa {qt6_generate_deploy_qml_app_script}{qt_generate_deploy_qml_app_script()}, - qt_deploy_runtime_dependencies(), QT_DEPLOY_QML_DIR + {qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()}, + QT_DEPLOY_QML_DIR \section1 Example @@ -86,7 +87,7 @@ qt_add_qml_module(MyApp # The following script must only be executed at install time set(deploy_script "${CMAKE_CURRENT_BINARY_DIR}/deploy_MyApp.cmake") -file(GENERATE OUTPUT ${deploy_script} CONTENTS " +file(GENERATE OUTPUT ${deploy_script} CONTENT " include(\"${QT_DEPLOY_SUPPORT}\") qt_deploy_qml_imports( # Deploy QML modules used by MyApp |