diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-28 10:35:03 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-05-12 13:06:42 +0000 |
| commit | 825d23a84687e67818dfff0485d08cd6d7186de3 (patch) | |
| tree | 51977b3ca42ac71dda1d3440ebdcc1d498270d1a | |
| parent | c5c87e2358d863b000c1e4ceda274ca6d7cea8e3 (diff) | |
| download | qtdeclarative-825d23a84687e67818dfff0485d08cd6d7186de3.tar.gz | |
Doc: Add missing \target keywords for QML macros
PAST_MAJOR_VERSIONS, PLUGIN_TARGET, NO_CREATE_PLUGIN_TARGET, and
CLASS_NAME are documented and elsewhere in the documentation we
try to link to them, but they were missing a \target.
Also, fix a link to QT_QML_SOURCE_TYPENAME.
Pick-to: 6.5
Change-Id: I74ff0de558d1f43b739f64a4bab19863f8be34cb
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
| -rw-r--r-- | src/qml/doc/src/cmake/qt_add_qml_module.qdoc | 8 |
1 files changed, 5 insertions, 3 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 72de6829f0..e241d66c37 100644 --- a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc +++ b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc @@ -315,9 +315,7 @@ JavaScript file names that are intended to be addressed as components should start with an uppercase letter. Alternatively, you may use lowercase file names and set the source file -property -\l{cmake-source-file-property-QT_QML_SOURCE_TYPENAME}{QT_QML_SOURCE_TYPE_NAME} -to the desired type name. +property \l QT_QML_SOURCE_TYPENAME to the desired type name. \target qml-cmake-singletons \section2 Singletons @@ -466,6 +464,7 @@ under the \c RESOURCE_PREFIX instead. This can be achieved by specifying the \c NO_RESOURCE_TARGET_PATH option, which may only be used if the backing target is an executable. +\target PAST_MAJOR_VERSIONS \section2 Registering past major versions \c PAST_MAJOR_VERSIONS contains a list of additional major version that the module @@ -556,6 +555,7 @@ These additional targets are generated internally by \c{qt_add_qml_module()} and are referenced by the backing target's linking requirements as part of ensuring that resources are set up and loaded correctly. +\target PLUGIN_TARGET \section2 Targets and plugin targets \c PLUGIN_TARGET specifies the plugin target associated with the QML module. @@ -580,6 +580,7 @@ link directly to the backing target and do not need a plugin, it can be disabled by adding the \c NO_PLUGIN option. Specifying both \c NO_PLUGIN and \c PLUGIN_TARGET is an error. +\target NO_CREATE_PLUGIN_TARGET In certain situations, the project may want to delay creating the plugin target until after the call. The \c NO_CREATE_PLUGIN_TARGET option can be given in that situation. The project is then expected to call @@ -587,6 +588,7 @@ that situation. The project is then expected to call been created. When \c NO_CREATE_PLUGIN_TARGET is given, \c PLUGIN_TARGET must also be provided to explicitly name the plugin target. +\target CLASS_NAME \target NO_GENERATE_PLUGIN_SOURCE By default, \c{qt_add_qml_module()} will auto-generate a \c{.cpp} file that implements the plugin class named by the \c CLASS_NAME argument. The generated |