1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Fix usage of \summary macro

Browse Source 
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>
This commit is contained in:
Topi Reinio 2021-10-12 09:09:34 +02:00
parent 3b6a027885
commit b836098179
22 changed files with 45 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/global/macros.qdocconf
View File

@ -46,7 +46,9 @@ macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
# Use like \brief, but replicates sentence also as text
# Used like \brief, but replicates the sentence also as text.
# Wrap the entire sentence with {}, for example:
# \summary {Creates a build target.}
macro.summary = "\\brief \1\n\n\1\n"
# Expands to the minor version based on the QT_VER environment variable

24
src/corelib/doc/src/cmake/cmake-properties.qdoc
View File

@ -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

12
src/corelib/doc/src/cmake/cmake-variables.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_executable.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_library.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_plugin.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_extract_metatypes.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_finalize_target.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_generate_moc.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_import_plugins.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_set_finalizer_mode.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
View File

@ -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

12
src/dbus/doc/src/qtdbus-cmake.qdoc
View File

@ -46,8 +46,8 @@ find_package(Qt6 COMPONENTS DBus REQUIRED)
\title qt_add_dbus_interface
\target qt6_add_dbus_interface
\summary Generates C++ sources implementing an interface for a D-Bus interface
description file.
\summary {Generates C++ sources implementing an interface for a D-Bus interface
description file.}
\include cmake-find-package-dbus.qdocinc
@ -112,8 +112,8 @@ Options can be set using \c set_source_file_property on the \c dbus_spec:
\title qt_add_dbus_interfaces
\target qt6_add_dbus_interfaces
\summary Generates C++ sources implementing interfaces for D-Bus interface
description files.
\summary {Generates C++ sources implementing interfaces for D-Bus interface
description files.}
\include cmake-find-package-dbus.qdocinc
@ -171,7 +171,7 @@ arguments:
\title qt_generate_dbus_interface
\target qt6_generate_dbus_interface
\summary Generates a D-Bus interface from a header file.
\summary {Generates a D-Bus interface from a header file.}
\include cmake-find-package-dbus.qdocinc
@ -208,7 +208,7 @@ arguments to the tool can be set after \c{OPTIONS}.
\title qt_add_dbus_adaptor
\target qt6_add_dbus_adaptor
\summary Generates an adaptor class for a D-Bus interface.
\summary {Generates an adaptor class for a D-Bus interface.}
\include cmake-find-package-dbus.qdocinc

2
src/widgets/doc/src/cmake-macros.qdoc
View File

@ -32,7 +32,7 @@
\title qt_wrap_ui
\target qt6_wrap_ui
\summary Creates sources for .ui files.
\summary {Creates sources for .ui files.}
\include cmake-find-package-widgets.qdocinc