summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-10-12 09:09:34 +0200
committerTopi Reinio <topi.reinio@qt.io>2021-10-12 14:08:08 +0200
commitb8360981791f876d835d3c3efcb1c6821e421b81 (patch)
treebaa34471acc8abb172f0d0f46bd38b49bd8fa124 /src/corelib/doc
parent3b6a02788523c88b0ceb2bc80364a4088dae1e47 (diff)
Doc: Fix usage of \summary macro
The macro takes only one parameter, sentences must be wrapped in {}. Pick-to: 6.2 Fixes: QTBUG-97441 Change-Id: I7177548a32a67d720c2b551d16c09d898b0fda51 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib/doc')
-rw-r--r--src/corelib/doc/src/cmake/cmake-properties.qdoc24
-rw-r--r--src/corelib/doc/src/cmake/cmake-variables.qdoc12
-rw-r--r--src/corelib/doc/src/cmake/qt_add_big_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_executable.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_library.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_plugin.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_finalize_target.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_generate_moc.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_import_plugins.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc2
19 files changed, 35 insertions, 35 deletions
diff --git a/src/corelib/doc/src/cmake/cmake-properties.qdoc b/src/corelib/doc/src/cmake/cmake-properties.qdoc
index 7b8dae7ee8..d379eed9c1 100644
--- a/src/corelib/doc/src/cmake/cmake-properties.qdoc
+++ b/src/corelib/doc/src/cmake/cmake-properties.qdoc
@@ -73,7 +73,7 @@ is listed before its dependencies, it will fail to load on some devices.
\title QT_ANDROID_EXTRA_LIBS
\target cmake-target-property-QT_ANDROID_EXTRA_LIBS
-\summary Extra libraries to deploy with the target.
+\summary {Extra libraries to deploy with the target.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -94,7 +94,7 @@ to enable OpenSSL in your application. For more information, see
\title QT_ANDROID_EXTRA_PLUGINS
\target cmake-target-property-QT_ANDROID_EXTRA_PLUGINS
-\summary Extra Qt plugins to deploy with the target.
+\summary {Extra Qt plugins to deploy with the target.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -124,7 +124,7 @@ mangling is applied to the plugin library.
\title QT_ANDROID_MIN_SDK_VERSION
\target cmake-target-property-QT_ANDROID_MIN_SDK_VERSION
-\summary Minimum Android SDK version.
+\summary {Minimum Android SDK version.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -142,7 +142,7 @@ Specifies the minimum Android API level for the target.
\title QT_ANDROID_PACKAGE_SOURCE_DIR
\target cmake-target-property-QT_ANDROID_PACKAGE_SOURCE_DIR
-\summary Path to a custom Android package template.
+\summary {Path to a custom Android package template.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -174,7 +174,7 @@ then place this directly into the directory specified by this variable.
\title QT_ANDROID_TARGET_SDK_VERSION
\target cmake-target-property-QT_ANDROID_TARGET_SDK_VERSION
-\summary Android target SDK version.
+\summary {Android target SDK version.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -192,7 +192,7 @@ Specifies the target Android API level for the target.
\title QT_ANDROID_VERSION_CODE
\target cmake-target-property-QT_ANDROID_VERSION_CODE
-\summary Internal Android app version.
+\summary {Internal Android app version.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -213,7 +213,7 @@ For more information, see \l{Android: App Versioning}{Android App Versioning}.
\title QT_ANDROID_VERSION_NAME
\target cmake-target-property-QT_ANDROID_VERSION_NAME
-\summary Human-readable Android app version.
+\summary {Human-readable Android app version.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -234,7 +234,7 @@ For more information, see \l{Android: App Versioning}{Android App Versioning}.
\title QT_QML_ROOT_PATH
\target cmake-target-property-QT_QML_ROOT_PATH
-\summary Overrides the location of the application's qml directory.
+\summary {Overrides the location of the application's qml directory.}
\preliminarycmakeproperty
@@ -254,7 +254,7 @@ will be used instead.
\title QT_QML_IMPORT_PATH
\target cmake-target-property-QT_QML_IMPORT_PATH
-\summary Specifies a list of directories to search for QML imports.
+\summary {Specifies a list of directories to search for QML imports.}
\preliminarycmakeproperty
@@ -275,7 +275,7 @@ For application-specific QML imports, use
\title QT_ANDROID_DEPLOYMENT_SETTINGS_FILE
\target cmake-target-property-QT_ANDROID_DEPLOYMENT_SETTINGS_FILE
-\summary Specifies the location of a target's generated deployment settings file.
+\summary {Specifies the location of a target's generated deployment settings file.}
\preliminarycmakeproperty
\cmakepropertyandroidonly
@@ -294,7 +294,7 @@ and overwritten by that command.
\title qt_no_entrypoint
\target cmake-target-property-qt_no_entrypoint
-\summary Specifies to inhibit linking against Qt's entrypoint lib.
+\summary {Specifies to inhibit linking against Qt's entrypoint lib.}
\preliminarycmakeproperty
@@ -312,7 +312,7 @@ On targets that must provide their own entry point, set the property \c qt_no_en
\title QT_RESOURCE_PREFIX
\target cmake-target-property-QT_RESOURCE_PREFIX
-\summary Specifies the default Qt resource prefix.
+\summary {Specifies the default Qt resource prefix.}
\preliminarycmakeproperty
diff --git a/src/corelib/doc/src/cmake/cmake-variables.qdoc b/src/corelib/doc/src/cmake/cmake-variables.qdoc
index d6feb215a3..af7a8b7aca 100644
--- a/src/corelib/doc/src/cmake/cmake-variables.qdoc
+++ b/src/corelib/doc/src/cmake/cmake-variables.qdoc
@@ -47,7 +47,7 @@ find_package(Qt6 COMPONENTS Core REQUIRED)
\title ANDROID_NDK_HOST_SYSTEM_NAME
\target cmake-variable-ANDROID_NDK_HOST_SYSTEM_NAME
-\summary Android-specific architecture of the host system.
+\summary {Android-specific architecture of the host system.}
\preliminarycmakevariable
\cmakevariableandroidonly
@@ -66,7 +66,7 @@ part of the deployment settings for a target.
\title ANDROID_SDK_ROOT
\target cmake-variable-ANDROID_SDK_ROOT
-\summary Location of the Android SDK.
+\summary {Location of the Android SDK.}
\preliminarycmakevariable
\cmakevariableandroidonly
@@ -85,7 +85,7 @@ It is written out as part of the deployment settings for a target.
\title QT_ANDROID_APPLICATION_ARGUMENTS
\target cmake-variable-QT_ANDROID_APPLICATION_ARGUMENTS
-\summary List of arguments to pass to Android applications.
+\summary {List of arguments to pass to Android applications.}
\preliminarycmakevariable
\cmakevariableandroidonly
@@ -104,7 +104,7 @@ out as part of the deployment settings for a target.
\title QT_HOST_PATH
\target cmake-variable-QT_HOST_PATH
-\summary Location of the host Qt installation when cross-compiling.
+\summary {Location of the host Qt installation when cross-compiling.}
\preliminarycmakevariable
@@ -121,7 +121,7 @@ platform. It is used to locate tools to be run on the host (\l{moc}, \l{rcc},
\title QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID
\target cmake-variable-QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID
-\summary Disables providing a fallback team ID during target finalization on iOS.
+\summary {Disables providing a fallback team ID during target finalization on iOS.}
When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
@@ -137,7 +137,7 @@ Set \c QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID to true if you want to prevent this.
\title QT_NO_SET_XCODE_BUNDLE_IDENTIFIER
\target cmake-variable-QT_NO_SET_XCODE_BUNDLE_IDENTIFIER
-\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.}
When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
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 fcc6ee130c..be3617a034 100644
--- a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
@@ -32,7 +32,7 @@
\title qt_add_big_resources
\target qt6_add_big_resources
-\summary Compiles big binary resources into object code.
+\summary {Compiles big binary resources into object code.}
\include cmake-find-package-core.qdocinc
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 0dddd8781e..b601093942 100644
--- a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
@@ -32,7 +32,7 @@
\title qt_add_binary_resources
\target qt6_add_binary_resources
-\summary Creates an RCC file from a list of Qt resource files.
+\summary {Creates an RCC file from a list of Qt resource files.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_add_executable.qdoc b/src/corelib/doc/src/cmake/qt_add_executable.qdoc
index cd27d65090..4302ea9ebe 100644
--- a/src/corelib/doc/src/cmake/qt_add_executable.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_executable.qdoc
@@ -32,7 +32,7 @@
\title qt_add_executable
\target qt6_add_executable
-\summary Creates and finalizes an application target of a platform-specific type.
+\summary {Creates and finalizes an application target of a platform-specific type.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_add_library.qdoc b/src/corelib/doc/src/cmake/qt_add_library.qdoc
index 0f9c442d8f..4865a5df93 100644
--- a/src/corelib/doc/src/cmake/qt_add_library.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_library.qdoc
@@ -32,7 +32,7 @@
\title qt_add_library
\target qt6_add_library
-\summary Creates and finalizes a library.
+\summary {Creates and finalizes a library.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
index fe20e56c63..f20b4c5afc 100644
--- a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
@@ -32,7 +32,7 @@
\title qt_add_plugin
\target qt6_add_plugin
-\summary Creates a Qt plugin target.
+\summary {Creates a Qt plugin target.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_add_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_resources.qdoc
index aae2862db6..c3709a9bf3 100644
--- a/src/corelib/doc/src/cmake/qt_add_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_resources.qdoc
@@ -32,7 +32,7 @@
\title qt_add_resources
\target qt6_add_resources
-\summary Compiles binary resources into source code.
+\summary {Compiles binary resources into source code.}
\include cmake-find-package-core.qdocinc
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 977deb0f52..1f65d298f7 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
@@ -32,7 +32,7 @@
\title qt_allow_non_utf8_sources
\target qt6_allow_non_utf8_sources
-\summary Prevents forcing source files to be treated as UTF-8 for Windows.
+\summary {Prevents forcing source files to be treated as UTF-8 for Windows.}
\include cmake-find-package-core.qdocinc
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 5bdbfe2f48..f07fb1bd8f 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
@@ -32,7 +32,7 @@
\title qt_android_add_apk_target
\target qt6_android_add_apk_target
-\summary Defines a build target that runs androiddeployqt to produce an APK.
+\summary {Defines a build target that runs androiddeployqt to produce an APK.}
\include cmake-find-package-core.qdocinc
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 0d5bdc5eae..570de072c4 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
@@ -32,7 +32,7 @@
\title qt_android_apply_arch_suffix
\target qt6_android_apply_arch_suffix
-\summary Configures the target binary's name to include an architecture-specific suffix.
+\summary {Configures the target binary's name to include an architecture-specific suffix.}
\include cmake-find-package-core.qdocinc
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 28387f67d3..aa48820386 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
@@ -32,7 +32,7 @@
\title qt_android_generate_deployment_settings
\target qt6_android_generate_deployment_settings
-\summary Generates the deployment settings file needed by androiddeployqt.
+\summary {Generates the deployment settings file needed by androiddeployqt.}
\include cmake-find-package-core.qdocinc
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 698a1766e8..956a272d6f 100644
--- a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
+++ b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
@@ -32,7 +32,7 @@
\title qt_disable_unicode_defines
\target qt6_disable_unicode_defines
-\summary Prevents some unicode-related compiler definitions being set automatically on a target.
+\summary {Prevents some unicode-related compiler definitions being set automatically on a target.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc b/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc
index af162fa63e..ccc81bdd2b 100644
--- a/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc
+++ b/src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc
@@ -32,7 +32,7 @@
\title qt_extract_metatypes
\target qt6_extract_metatypes
-\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.}
\preliminarycmakecommand
diff --git a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
index b0c6e9ec91..eb3e7a479b 100644
--- a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
+++ b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
@@ -32,7 +32,7 @@
\title qt_finalize_target
\target qt6_finalize_target
-\summary Handles various common platform-specific tasks associated with Qt targets.
+\summary {Handles various common platform-specific tasks associated with Qt targets.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
index 33d16cd0e4..c51001e3eb 100644
--- a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
+++ b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
@@ -32,7 +32,7 @@
\title qt_generate_moc
\target qt6_generate_moc
-\summary Calls moc on an input file.
+\summary {Calls moc on an input file.}
\include cmake-find-package-core.qdocinc
diff --git a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
index 84cb5cae63..98e81bfeff 100644
--- a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
+++ b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
@@ -32,7 +32,7 @@
\title qt_import_plugins
\target qt6_import_plugins
-\summary Specifies a custom set of plugins to import for a static Qt build.
+\summary {Specifies a custom set of plugins to import for a static Qt build.}
\include cmake-find-package-core.qdocinc
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 909100de72..2210e86fa6 100644
--- a/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc
+++ b/src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc
@@ -32,7 +32,7 @@
\title qt_set_finalizer_mode
\target qt6_set_finalizer_mode
-\summary Customizes aspects of a target's finalization.
+\summary {Customizes aspects of a target's finalization.}
\preliminarycmakecommand
diff --git a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
index 7713b77546..f1731ed825 100644
--- a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
+++ b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
@@ -32,7 +32,7 @@
\title qt_wrap_cpp
\target qt6_wrap_cpp
-\summary Creates .moc files from sources.
+\summary {Creates .moc files from sources.}
\include cmake-find-package-core.qdocinc