Doc: State Qt versions for when CMake commands etc. were introduced

Introduce the qdoc macros \cmakecommandsince, \cmakepropertysince, and
\cmakevariablesince that insert a paragraph akin to the \since context
command.

Example:
    \cmakecommandsince 6.3
produces the paragraph
    This command was introduced in Qt 6.3

The macro text is wrapped in \n\n to ensure that we always generate a
new paragraph.

Pick-to: 6.2 6.3
Task-number: QTBUG-100212
Change-Id: Id5c8e8812e6b0b915674d108a0e775091e9eacd8
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
This commit is contained in:
Joerg Bornemann 2022-01-26 15:29:17 +01:00
parent 1031fa1547
commit 0ad8dd4805
25 changed files with 76 additions and 1 deletions

View File

@ -74,6 +74,10 @@ macro.preliminarycmakecommand = "\\note This command is in technology preview a
macro.preliminarycmakevariable = "\\note This variable is in technology preview and may change in future releases." macro.preliminarycmakevariable = "\\note This variable is in technology preview and may change in future releases."
macro.preliminarycmakeproperty = "\\note This property is in technology preview and may change in future releases." macro.preliminarycmakeproperty = "\\note This property is in technology preview and may change in future releases."
macro.cmakecommandsince = "\n\nThis command was introduced in Qt \1.\n\n"
macro.cmakevariablesince = "\n\nThis variable was introduced in Qt \1.\n\n"
macro.cmakepropertysince = "\n\nThis property was introduced in Qt \1.\n\n"
macro.cmakecommandandroidonly = "\\note This command should only be called if targeting the Android platform." macro.cmakecommandandroidonly = "\\note This command should only be called if targeting the Android platform."
macro.cmakepropertyandroidonly = "\\note This property is used only if targeting the Android platform." macro.cmakepropertyandroidonly = "\\note This property is used only if targeting the Android platform."
macro.cmakevariableandroidonly = "\\note This variable is used only if targeting the Android platform." macro.cmakevariableandroidonly = "\\note This variable is used only if targeting the Android platform."

View File

@ -55,6 +55,7 @@ find_package(Qt6 REQUIRED COMPONENTS Core)
\summary {Android-specific architecture of the host system.} \summary {Android-specific architecture of the host system.}
\cmakevariablesince 6.0
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -74,6 +75,7 @@ part of the deployment settings for a target.
\summary {Location of the Android SDK.} \summary {Location of the Android SDK.}
\cmakevariablesince 6.0
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -93,6 +95,7 @@ It is written out as part of the deployment settings for a target.
\summary {List of arguments to pass to Android applications.} \summary {List of arguments to pass to Android applications.}
\cmakevariablesince 6.0
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -112,6 +115,7 @@ out as part of the deployment settings for a target.
\summary {Enables building multi-ABI packages using the autodetected Qt for Android SDK list.} \summary {Enables building multi-ABI packages using the autodetected Qt for Android SDK list.}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -144,6 +148,7 @@ The variable is set to FALSE by default.
\summary {List of ABIs that the project packages are built for.} \summary {List of ABIs that the project packages are built for.}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -169,6 +174,7 @@ QT_ANDROID_ABIS logic.
\summary {Set of variables to specify the path to Qt for Android for the corresponding ABI.} \summary {Set of variables to specify the path to Qt for Android for the corresponding ABI.}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \cmakevariableandroidonly
@ -188,6 +194,7 @@ The list of supported ABIs can be found in the \c{QT_ANDROID_ABIS} variable docu
\summary {Location of the host Qt installation when cross-compiling.} \summary {Location of the host Qt installation when cross-compiling.}
\cmakevariablesince 6.0
\preliminarycmakevariable \preliminarycmakevariable
When cross-compiling, this must be set to the install location of Qt for the host When cross-compiling, this must be set to the install location of Qt for the host
@ -205,6 +212,8 @@ platform. It is used to locate tools to be run on the host (\l{moc}, \l{rcc},
\summary {Disables providing a fallback team ID during target finalization on iOS.} \summary {Disables providing a fallback team ID during target finalization on iOS.}
\cmakevariablesince 6.1
When finalizing an executable target on iOS, When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's \l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
\c XCODE_ATTRIBUTE_DEVELOPMENT_TEAM property if it hasn't been set. \c XCODE_ATTRIBUTE_DEVELOPMENT_TEAM property if it hasn't been set.
@ -221,6 +230,8 @@ Set \c QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID to true if you want to prevent this.
\summary {Disables providing a fallback app bundle ID during target finalization on iOS.} \summary {Disables providing a fallback app bundle ID during target finalization on iOS.}
\cmakevariablesince 6.1
When finalizing an executable target on iOS, When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's \l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
\c XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER and \c XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER and
@ -238,6 +249,7 @@ Set \c QT_NO_SET_XCODE_BUNDLE_IDENTIFIER to true if you want to prevent this.
\summary {Enables verbose mode of deployment tools} \summary {Enables verbose mode of deployment tools}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
Enables verbose mode of the \l androiddeployqt deployment tool when it is called Enables verbose mode of the \l androiddeployqt deployment tool when it is called
@ -258,6 +270,7 @@ must be set before the first \c{find_package(Qt6)} call to have that effect.
\summary {Name of the file to include for setting up deployment support.} \summary {Name of the file to include for setting up deployment support.}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
This variable is set by the Core package. It is intended to be used as the first This variable is set by the Core package. It is intended to be used as the first
@ -282,6 +295,7 @@ an application, along with its runtime dependencies:
\summary {Prevents subsequent calls to qt_standard_project_setup() from making any changes.} \summary {Prevents subsequent calls to qt_standard_project_setup() from making any changes.}
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
The \l{qt6_standard_project_setup}{qt_standard_project_setup()} command is The \l{qt6_standard_project_setup}{qt_standard_project_setup()} command is
@ -295,4 +309,3 @@ methods provided by CMake.
\sa {qt6_standard_project_setup}{qt_standard_project_setup()} \sa {qt6_standard_project_setup}{qt_standard_project_setup()}
*/ */

View File

@ -43,6 +43,7 @@
\include cmake-deploy-var-usage.qdocinc \include cmake-deploy-var-usage.qdocinc
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\c{QT_DEPLOY_PREFIX} provides the base directory of the deployment. The other \c{QT_DEPLOY_PREFIX} provides the base directory of the deployment. The other
@ -80,6 +81,7 @@ variables.
\include cmake-deploy-var-usage.qdocinc \include cmake-deploy-var-usage.qdocinc
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
Projects should use \c QT_DEPLOY_BIN_DIR in their deploy scripts instead of Projects should use \c QT_DEPLOY_BIN_DIR in their deploy scripts instead of
@ -117,6 +119,7 @@ should not be used for that scenario.
\include cmake-deploy-var-usage.qdocinc \include cmake-deploy-var-usage.qdocinc
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
Projects should use \c QT_DEPLOY_LIB_DIR in their deploy scripts instead of Projects should use \c QT_DEPLOY_LIB_DIR in their deploy scripts instead of
@ -150,6 +153,7 @@ should not be used for that scenario.
\include cmake-deploy-var-usage.qdocinc \include cmake-deploy-var-usage.qdocinc
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
Projects should use \c QT_DEPLOY_PLUGINS_DIR in their deploy scripts instead of Projects should use \c QT_DEPLOY_PLUGINS_DIR in their deploy scripts instead of
@ -178,6 +182,7 @@ bundle contents.
\include cmake-deploy-var-usage.qdocinc \include cmake-deploy-var-usage.qdocinc
\cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
Projects should use \c QT_DEPLOY_QML_DIR in their deploy scripts instead of Projects should use \c QT_DEPLOY_QML_DIR in their deploy scripts instead of

View File

@ -45,6 +45,7 @@ target properties:
\brief Overrides the Qt dependencies added to the target's deployment. \brief Overrides the Qt dependencies added to the target's deployment.
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -75,6 +76,7 @@ is listed before its dependencies, it will fail to load on some devices.
\summary {Extra libraries to deploy with the target.} \summary {Extra libraries to deploy with the target.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -96,6 +98,7 @@ to enable OpenSSL in your application. For more information, see
\summary {Extra Qt plugins to deploy with the target.} \summary {Extra Qt plugins to deploy with the target.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -126,6 +129,7 @@ mangling is applied to the plugin library.
\summary {Minimum Android SDK version.} \summary {Minimum Android SDK version.}
\cmakepropertysince 6.1
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -144,6 +148,7 @@ Specifies the minimum Android API level for the target.
\summary {Path to a custom Android package template.} \summary {Path to a custom Android package template.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -176,6 +181,7 @@ then place this directly into the directory specified by this variable.
\summary {Android target SDK version.} \summary {Android target SDK version.}
\cmakepropertysince 6.1
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -194,6 +200,7 @@ Specifies the target Android API level for the target.
\summary {Internal Android app version.} \summary {Internal Android app version.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -215,6 +222,7 @@ For more information, see \l{Android: App Versioning}{Android App Versioning}.
\summary {Human-readable Android app version.} \summary {Human-readable Android app version.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -236,6 +244,7 @@ For more information, see \l{Android: App Versioning}{Android App Versioning}.
\summary {List of ABIs that packages of a single target are built for.} \summary {List of ABIs that packages of a single target are built for.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -255,6 +264,7 @@ the list of ABIs that the single target packages are supposed to be built for.
\summary {Overrides the location of the application's qml directory.} \summary {Overrides the location of the application's qml directory.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
This property is currently only used when generating a deployment settings file This property is currently only used when generating a deployment settings file
@ -275,6 +285,7 @@ will be used instead.
\summary {Specifies a list of directories to search for QML imports.} \summary {Specifies a list of directories to search for QML imports.}
\cmakepropertysince 6.3
\preliminarycmakeproperty \preliminarycmakeproperty
This property is currently only used when generating a deployment settings file This property is currently only used when generating a deployment settings file
@ -296,6 +307,7 @@ For application-specific QML imports, use
\summary {Specifies the location of a target's generated deployment settings file.} \summary {Specifies the location of a target's generated deployment settings file.}
\cmakepropertysince 6.0
\preliminarycmakeproperty \preliminarycmakeproperty
\cmakepropertyandroidonly \cmakepropertyandroidonly
@ -315,6 +327,7 @@ and overwritten by that command.
\summary {Specifies to inhibit linking against Qt's entrypoint lib.} \summary {Specifies to inhibit linking against Qt's entrypoint lib.}
\cmakepropertysince 6.1
\preliminarycmakeproperty \preliminarycmakeproperty
On certain platforms, Qt applications link against Qt's entrypoint lib by default. On certain platforms, Qt applications link against Qt's entrypoint lib by default.
@ -333,6 +346,7 @@ On targets that must provide their own entry point, set the property \c qt_no_en
\summary {Specifies the default Qt resource prefix.} \summary {Specifies the default Qt resource prefix.}
\cmakepropertysince 6.0
\preliminarycmakeproperty \preliminarycmakeproperty
When using \l{qt6_add_resources}{qt_add_resources} without a \c PREFIX When using \l{qt6_add_resources}{qt_add_resources} without a \c PREFIX

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 5.12
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 5.10
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.2
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,7 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\preliminarycmakecommand \preliminarycmakecommand
\cmakecommandandroidonly \cmakecommandandroidonly

View File

@ -36,6 +36,7 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\preliminarycmakecommand \preliminarycmakecommand
\cmakecommandandroidonly \cmakecommandandroidonly

View File

@ -36,6 +36,7 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.0
\preliminarycmakecommand \preliminarycmakecommand
\cmakecommandandroidonly \cmakecommandandroidonly

View File

@ -40,6 +40,7 @@ Unlike most other CMake commands provided by Qt, \c{qt_deploy_qt_conf()} can
only be called from a deployment script. It cannot be called directly by the only be called from a deployment script. It cannot be called directly by the
project. project.
\cmakecommandsince 6.3
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -40,6 +40,7 @@ Unlike most other CMake commands provided by Qt, \c{qt_deploy_runtime_dependenci
can only be called from a deployment script. It cannot be called directly by the can only be called from a deployment script. It cannot be called directly by the
project during the configure stage. project during the configure stage.
\cmakecommandsince 6.3
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.2
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -34,6 +34,7 @@
\summary {Extracts metatypes from a Qt target and generates an associated metatypes.json file.} \summary {Extracts metatypes from a Qt target and generates an associated metatypes.json file.}
\cmakecommandsince 6.0
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.3
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,7 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.3
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 5.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 5.14
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -34,6 +34,7 @@
\summary {Customizes aspects of a target's finalization.} \summary {Customizes aspects of a target's finalization.}
\cmakecommandsince 6.3
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -36,6 +36,7 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 6.3
\preliminarycmakecommand \preliminarycmakecommand
\section1 Synopsis \section1 Synopsis

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc \include cmake-find-package-core.qdocinc
\cmakecommandsince 5.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode

View File

@ -51,6 +51,8 @@ description file.}
\include cmake-find-package-dbus.qdocinc \include cmake-find-package-dbus.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode
@ -117,6 +119,8 @@ description files.}
\include cmake-find-package-dbus.qdocinc \include cmake-find-package-dbus.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode
@ -175,6 +179,8 @@ arguments:
\include cmake-find-package-dbus.qdocinc \include cmake-find-package-dbus.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode
@ -212,6 +218,8 @@ arguments to the tool can be set after \c{OPTIONS}.
\include cmake-find-package-dbus.qdocinc \include cmake-find-package-dbus.qdocinc
\cmakecommandsince 6.0
\section1 Synopsis \section1 Synopsis
\badcode \badcode