qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: fix links to cmake functions 

Follow the convention that we link to qt6_ prefixed functions, but refer
to them in the documentation with only a qt_ prefix and trailing
parenths.

Pick-to: 6.5 6.5.0
Change-Id: Icd0d5e51d1147f159aaaa4cc7f7faac6dfea5df5
Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
This commit is contained in:
Volker Hilsheimer 2023-03-08 16:52:11 +01:00
parent 57905da94f
commit 87d06eac15
3 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/qml/doc/src/cmake/qt_add_qml_module.qdoc
View File

@ -662,13 +662,13 @@ code will be generated into a C++ namespace of this name.
For static Qt builds, \c{qmlimportscanner} is run at configure time to scan the
\c{.qml} files of a QML module and identify the QML imports it uses (see
\l{qt6_import_qml_plugins}{qt_import_qml_plugins()}). For non-static Qt builds,
if the target is an executable, a similar scan is performed at build time
to provide the information needed by deployment scripts (see
\l{qt_deploy_qml_imports()}). Both scans can be disabled by providing the
\c{NO_IMPORT_SCAN} option. Doing so means the project takes on the
responsibility of ensuring all required plugins are instantiated and linked for
static builds. For non-static builds the project must manually work out
and deploy all QML modules used by an executable target.
if the target is an executable, a similar scan is performed at build time to
provide the information needed by deployment scripts (see
\l{qt6_deploy_qml_imports}{qt_deploy_qml_imports()}). Both scans can be
disabled by providing the \c{NO_IMPORT_SCAN} option. Doing so means the project
takes on the responsibility of ensuring all required plugins are instantiated
and linked for static builds. For non-static builds the project must manually
work out and deploy all QML modules used by an executable target.
\section2 Arguments for qmltc

17
src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc
View File

@ -12,9 +12,9 @@
\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}{qt_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
@ -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}{qt_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

11
src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc
View File

@ -68,9 +68,11 @@ is only written at CMake generate-time. It is intended to be used with the
\l{install(SCRIPT)} command, which should come after the application's target
has been installed using \l{install(TARGETS)}.
The deployment script will call \l{qt_deploy_qml_imports()} with a suitable set
of options for the standard install layout. For macOS app bundles and Windows
targets, it will then also call \l{qt_deploy_runtime_dependencies()}, again
The deployment script will call
\l{qt6_deploy_qml_imports}{qt_deploy_qml_imports()} with a suitable set of
options for the standard install layout. For macOS app bundles and Windows
targets, it will then also call
\l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()}, again
with suitable options for the standard install layout.
Calling \c{qt_generate_deploy_qml_app_script()} for a platform that is not
@ -101,7 +103,8 @@ The options \c{PRE_INCLUDE_REGEXES}, \c{PRE_EXCLUDE_REGEXES},
\c{POST_INCLUDE_REGEXES}, \c{POST_EXCLUDE_REGEXES}, \c{POST_INCLUDE_FILES}, and
\c{POST_EXCLUDE_FILES} can be specified to control the deployment of runtime
dependencies. These options do not apply to all platforms and are forwarded
unmodified to \l{qt_deploy_runtime_dependencies()}.
unmodified to
\l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()}.
For deploying a non-QML application, use
\l{qt6_generate_deploy_app_script}{qt_generate_deploy_app_script()}