From 214afbdddffc434414cc619557dd6426263f8193 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20K=C3=B6hne?= Date: Fri, 24 Sep 2021 07:50:24 +0200 Subject: [PATCH] Doc: Make it explicit when CMake API is defined Task-number: QTBUG-96239 Pick-to: 6.2 Change-Id: Iaa99024f98f5422aa39f148a89594186b40344bf Reviewed-by: Edward Welbourne Reviewed-by: Paul Wicking --- src/corelib/doc/src/cmake/qt_add_big_resources.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_add_executable.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_add_library.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_add_plugin.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_add_resources.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc | 2 ++ .../doc/src/cmake/qt_android_apply_arch_suffix.qdoc | 2 ++ .../cmake/qt_android_generate_deployment_settings.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_finalize_target.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_generate_moc.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_import_plugins.qdoc | 2 ++ src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc | 2 ++ .../doc/src/includes/cmake-find-package-core.qdocinc | 5 +++++ src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc | 5 +++++ src/dbus/doc/src/qtdbus-cmake.qdoc | 8 ++++++++ src/widgets/doc/src/cmake-macros.qdoc | 2 ++ .../doc/src/includes/cmake-find-package-widgets.qdocinc | 5 +++++ 20 files changed, 55 insertions(+) create mode 100644 src/corelib/doc/src/includes/cmake-find-package-core.qdocinc create mode 100644 src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc create mode 100644 src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc diff --git a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc index d77ff90b48..02e817eb56 100644 --- a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc @@ -34,6 +34,8 @@ \summary Compiles big binary resources into object code. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc index b17a3a474b..0dddd8781e 100644 --- a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc @@ -34,6 +34,8 @@ \summary Creates an RCC file from a list of Qt resource files. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_add_executable.qdoc b/src/corelib/doc/src/cmake/qt_add_executable.qdoc index 4a807ecb7c..cd27d65090 100644 --- a/src/corelib/doc/src/cmake/qt_add_executable.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_executable.qdoc @@ -34,6 +34,8 @@ \summary Creates and finalizes an application target of a platform-specific type. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_add_library.qdoc b/src/corelib/doc/src/cmake/qt_add_library.qdoc index b39c197a8f..0f9c442d8f 100644 --- a/src/corelib/doc/src/cmake/qt_add_library.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_library.qdoc @@ -34,6 +34,8 @@ \summary Creates and finalizes a library. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc index 9bd08c20f4..fe20e56c63 100644 --- a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc @@ -34,6 +34,8 @@ \summary Creates a Qt plugin target. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_add_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_resources.qdoc index f0a6ff860e..aae2862db6 100644 --- a/src/corelib/doc/src/cmake/qt_add_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_resources.qdoc @@ -34,6 +34,8 @@ \summary Compiles binary resources into source code. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc index de88676d25..977deb0f52 100644 --- a/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc +++ b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc @@ -34,6 +34,8 @@ \summary Prevents forcing source files to be treated as UTF-8 for Windows. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc b/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc index d88dafcb07..5bdbfe2f48 100644 --- a/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc +++ b/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc @@ -34,6 +34,8 @@ \summary Defines a build target that runs androiddeployqt to produce an APK. +\include cmake-find-package-core.qdocinc + \preliminarycmakecommand \cmakecommandandroidonly diff --git a/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc b/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc index 8945813cb1..0d5bdc5eae 100644 --- a/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc +++ b/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc @@ -34,6 +34,8 @@ \summary Configures the target binary's name to include an architecture-specific suffix. +\include cmake-find-package-core.qdocinc + \preliminarycmakecommand \cmakecommandandroidonly diff --git a/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc index fdfec1444f..28387f67d3 100644 --- a/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc +++ b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc @@ -34,6 +34,8 @@ \summary Generates the deployment settings file needed by androiddeployqt. +\include cmake-find-package-core.qdocinc + \preliminarycmakecommand \cmakecommandandroidonly diff --git a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc index a30cfca3f9..698a1766e8 100644 --- a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc +++ b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc @@ -34,6 +34,8 @@ \summary Prevents some unicode-related compiler definitions being set automatically on a target. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc index d72bc4fd8f..b0c6e9ec91 100644 --- a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc +++ b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc @@ -34,6 +34,8 @@ \summary Handles various common platform-specific tasks associated with Qt targets. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc index 2c37bb58c9..33d16cd0e4 100644 --- a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc +++ b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc @@ -34,6 +34,8 @@ \summary Calls moc on an input file. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc index f7922ae103..84cb5cae63 100644 --- a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc +++ b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc @@ -34,6 +34,8 @@ \summary Specifies a custom set of plugins to import for a static Qt build. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc index 2fee20d536..032c4da6e7 100644 --- a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc +++ b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc @@ -34,6 +34,8 @@ \summary Creates .moc files from sources. +\include cmake-find-package-core.qdocinc + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/includes/cmake-find-package-core.qdocinc b/src/corelib/doc/src/includes/cmake-find-package-core.qdocinc new file mode 100644 index 0000000000..4bf3892aa2 --- /dev/null +++ b/src/corelib/doc/src/includes/cmake-find-package-core.qdocinc @@ -0,0 +1,5 @@ +The command is defined in the \c Core component of the \c Qt6 package. Load the package with: + +\code +find_package(Qt6 COMPONENTS Core REQUIRED) +\endcode diff --git a/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc b/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc new file mode 100644 index 0000000000..d72102831e --- /dev/null +++ b/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc @@ -0,0 +1,5 @@ +The command is defined in the \c DBus component of the \c Qt6 package. Load the package with: + +\code +find_package(Qt6 COMPONENTS DBus REQUIRED) +\endcode diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index a315fe47b1..06410eaf94 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -49,6 +49,8 @@ find_package(Qt6 COMPONENTS DBus REQUIRED) \summary Generates C++ sources implementing an interface for a D-Bus interface description file. +\include cmake-find-package-dbus.qdocinc + \section1 Synopsis \badcode @@ -113,6 +115,8 @@ Options can be set using \c set_source_file_property on the \c dbus_spec: \summary Generates C++ sources implementing interfaces for D-Bus interface description files. +\include cmake-find-package-dbus.qdocinc + \section1 Synopsis \badcode @@ -169,6 +173,8 @@ arguments: \summary Generates a D-Bus interface from a header file. +\include cmake-find-package-dbus.qdocinc + \section1 Synopsis \badcode @@ -204,6 +210,8 @@ arguments to the tool can be set after \c{OPTIONS}. \summary Generates an adaptor class for a D-Bus interface. +\include cmake-find-package-dbus.qdocinc + \section1 Synopsis \badcode diff --git a/src/widgets/doc/src/cmake-macros.qdoc b/src/widgets/doc/src/cmake-macros.qdoc index f4662dee9f..2b75865f0f 100644 --- a/src/widgets/doc/src/cmake-macros.qdoc +++ b/src/widgets/doc/src/cmake-macros.qdoc @@ -34,6 +34,8 @@ \summary Creates sources for .ui files. +\include cmake-find-package-widgets.qdocinc + \section1 Synopsis \badcode diff --git a/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc b/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc new file mode 100644 index 0000000000..547e39c0cc --- /dev/null +++ b/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc @@ -0,0 +1,5 @@ +The command is defined in the \c Widgets component of the \c Qt6 package. Load the package with: + +\code +find_package(Qt6 COMPONENTS Widgets REQUIRED) +\endcode