From 5e28b5a9ec28bb6facddf44472576dbb7cd0d6df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20K=C3=B6hne?= Date: Tue, 13 Dec 2022 12:02:27 +0100 Subject: [PATCH] Doc: Use \keyword for alternative name of CMake command \target will let the browser jump right below the title. Instead, open the page from the start. Change-Id: Ia58664aa2696aca4f299d57b8dbaa9b6cda90f27 Reviewed-by: Pranta Ghosh Dastider Reviewed-by: Leena Miettinen (cherry picked from commit 958dc5c1cd314358d6af3d7184c01ad62847b82d) Reviewed-by: Qt Cherry-pick Bot --- 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_extract_metatypes.qdoc | 2 +- src/corelib/doc/src/cmake/qt_finalize_project.qdoc | 2 +- src/corelib/doc/src/cmake/qt_finalize_target.qdoc | 2 +- .../doc/src/cmake/qt_generate_deploy_app_script.qdoc | 2 +- src/corelib/doc/src/cmake/qt_generate_deploy_script.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_set_finalizer_mode.qdoc | 2 +- src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc | 2 +- src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc | 2 +- src/dbus/doc/src/qtdbus-cmake.qdoc | 8 ++++---- src/widgets/doc/src/cmake-macros.qdoc | 2 +- 23 files changed, 26 insertions(+), 26 deletions(-) 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 72a00e6eef9..8215d4c717a 100644 --- a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_big_resources -\target qt6_add_big_resources +\keyword qt6_add_big_resources \summary {Compiles big binary resources into object code.} 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 71ee8b894ed..12ee5e1affb 100644 --- a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_binary_resources -\target qt6_add_binary_resources +\keyword qt6_add_binary_resources \summary {Creates an RCC file from a list of Qt resource files.} diff --git a/src/corelib/doc/src/cmake/qt_add_executable.qdoc b/src/corelib/doc/src/cmake/qt_add_executable.qdoc index 6bdc6000e84..97f415f6c4c 100644 --- a/src/corelib/doc/src/cmake/qt_add_executable.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_executable.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_executable -\target qt6_add_executable +\keyword qt6_add_executable \summary {Creates and finalizes an application target of a platform-specific type.} diff --git a/src/corelib/doc/src/cmake/qt_add_library.qdoc b/src/corelib/doc/src/cmake/qt_add_library.qdoc index 6a5d17f0f94..66336da4b9e 100644 --- a/src/corelib/doc/src/cmake/qt_add_library.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_library.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_library -\target qt6_add_library +\keyword qt6_add_library \summary {Creates and finalizes a library.} diff --git a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc index b19fecd6018..d2322086e7e 100644 --- a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_plugin -\target qt6_add_plugin +\keyword qt6_add_plugin \summary {Creates a Qt plugin target.} diff --git a/src/corelib/doc/src/cmake/qt_add_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_resources.qdoc index 982cf207afc..48933617226 100644 --- a/src/corelib/doc/src/cmake/qt_add_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_resources.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_add_resources -\target qt6_add_resources +\keyword qt6_add_resources \summary {Compiles binary resources into source code.} 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 617baa01095..ad95401f4d9 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 @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_allow_non_utf8_sources -\target qt6_allow_non_utf8_sources +\keyword qt6_allow_non_utf8_sources \summary {Prevents forcing source files to be treated as UTF-8 for Windows.} 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 4ab9b3d53d7..b2415730f5f 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 @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_android_add_apk_target -\target qt6_android_add_apk_target +\keyword qt6_android_add_apk_target \summary {Defines a build target that runs androiddeployqt to produce an APK.} 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 363bba1097d..a29e1f6123d 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 @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_android_apply_arch_suffix -\target qt6_android_apply_arch_suffix +\keyword qt6_android_apply_arch_suffix \summary {Configures the target binary's name to include an architecture-specific suffix.} 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 d71fa092f82..5a7bbdc33f5 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 @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_android_generate_deployment_settings -\target qt6_android_generate_deployment_settings +\keyword qt6_android_generate_deployment_settings \summary {Generates the deployment settings file needed by androiddeployqt.} 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 f4ad3c64260..91de52544e1 100644 --- a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc +++ b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_disable_unicode_defines -\target qt6_disable_unicode_defines +\keyword qt6_disable_unicode_defines \summary {Prevents some unicode-related compiler definitions being set automatically on a target.} diff --git a/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc b/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc index 837baa3f0c7..7d9cd936fff 100644 --- a/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc +++ b/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_extract_metatypes -\target qt6_extract_metatypes +\keyword qt6_extract_metatypes \summary {Extracts metatypes from a Qt target and generates an associated metatypes.json file.} diff --git a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc index 56ab40055c1..9beb427050a 100644 --- a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc +++ b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_finalize_project -\target qt6_finalize_project +\keyword qt6_finalize_project \summary {Handles various common platform-specific tasks associated with a Qt project.} \preliminarycmakecommand diff --git a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc index 4b71248a1eb..17b18daffef 100644 --- a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc +++ b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_finalize_target -\target qt6_finalize_target +\keyword qt6_finalize_target \summary {Handles various common platform-specific tasks associated with Qt targets.} diff --git a/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc b/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc index 4f506cdf5d7..ece126bffc5 100644 --- a/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc +++ b/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_generate_deploy_app_script -\target qt6_generate_deploy_app_script +\keyword qt6_generate_deploy_app_script \summary {Generate a deployment script for an application.} diff --git a/src/corelib/doc/src/cmake/qt_generate_deploy_script.qdoc b/src/corelib/doc/src/cmake/qt_generate_deploy_script.qdoc index 7f05373c85c..eb8ed402a9b 100644 --- a/src/corelib/doc/src/cmake/qt_generate_deploy_script.qdoc +++ b/src/corelib/doc/src/cmake/qt_generate_deploy_script.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_generate_deploy_script -\target qt6_generate_deploy_script +\keyword qt6_generate_deploy_script \summary {Generate a custom deployment script.} diff --git a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc index 55b6df9e7de..9b123f9323c 100644 --- a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc +++ b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_generate_moc -\target qt6_generate_moc +\keyword qt6_generate_moc \summary {Calls moc on an input file.} diff --git a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc index b9606654b08..4b612206ee2 100644 --- a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc +++ b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_import_plugins -\target qt6_import_plugins +\keyword qt6_import_plugins \summary {Specifies a custom set of plugins to import for a static Qt build.} diff --git a/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc b/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc index f44a217544c..28622c11e8f 100644 --- a/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc +++ b/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_set_finalizer_mode -\target qt6_set_finalizer_mode +\keyword qt6_set_finalizer_mode \summary {Customizes aspects of a target's finalization.} diff --git a/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc b/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc index 6c1763ec3ee..92457b30cbe 100644 --- a/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc +++ b/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_standard_project_setup -\target qt6_standard_project_setup +\keyword qt6_standard_project_setup \summary {Setup project-wide defaults to a standard arrangement.} diff --git a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc index c2a916c71cf..03b7a866a7a 100644 --- a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc +++ b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-commands-qtcore \title qt_wrap_cpp -\target qt6_wrap_cpp +\keyword qt6_wrap_cpp \summary {Creates .moc files from sources.} diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index 2748fe6d0b5..d64b3157961 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -21,7 +21,7 @@ find_package(Qt6 REQUIRED COMPONENTS DBus) \ingroup cmake-commands-qtdbus \title qt_add_dbus_interface -\target qt6_add_dbus_interface +\keyword qt6_add_dbus_interface \summary {Generates C++ sources implementing an interface for a D-Bus interface description file.} @@ -89,7 +89,7 @@ Options can be set using \c set_source_files_properties on the \c dbus_spec: \ingroup cmake-commands-qtdbus \title qt_add_dbus_interfaces -\target qt6_add_dbus_interfaces +\keyword qt6_add_dbus_interfaces \summary {Generates C++ sources implementing interfaces for D-Bus interface description files.} @@ -150,7 +150,7 @@ arguments: \ingroup cmake-commands-qtdbus \title qt_generate_dbus_interface -\target qt6_generate_dbus_interface +\keyword qt6_generate_dbus_interface \summary {Generates a D-Bus interface from a header file.} @@ -189,7 +189,7 @@ arguments to the tool can be set after \c{OPTIONS}. \ingroup cmake-commands-qtdbus \title qt_add_dbus_adaptor -\target qt6_add_dbus_adaptor +\keyword qt6_add_dbus_adaptor \summary {Generates an adaptor class for a D-Bus interface.} diff --git a/src/widgets/doc/src/cmake-macros.qdoc b/src/widgets/doc/src/cmake-macros.qdoc index 34bc2549625..13bdcca67bc 100644 --- a/src/widgets/doc/src/cmake-macros.qdoc +++ b/src/widgets/doc/src/cmake-macros.qdoc @@ -6,7 +6,7 @@ \ingroup cmake-macros-qtwidgets \title qt_wrap_ui -\target qt6_wrap_ui +\keyword qt6_wrap_ui \summary {Creates sources for .ui files.}