AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Make it explicit when CMake API is defined

Browse Source 
Task-number: QTBUG-96239
Pick-to: 6.2
Change-Id: Iaa99024f98f5422aa39f148a89594186b40344bf
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Kai Köhne 2021-09-24 07:50:24 +02:00
parent 5381f6c877
commit 214afbdddf
20 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -34,6 +34,8 @@
\summary Compiles big binary resources into object code.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

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

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

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

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

@ -34,6 +34,8 @@
\summary Creates and finalizes a library.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

@ -34,6 +34,8 @@
\summary Creates a Qt plugin target.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

@ -34,6 +34,8 @@
\summary Compiles binary resources into source code.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

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

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

@ -34,6 +34,8 @@
\summary Defines a build target that runs androiddeployqt to produce an APK.
\include cmake-find-package-core.qdocinc
\preliminarycmakecommand
\cmakecommandandroidonly

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

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

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

@ -34,6 +34,8 @@
\summary Generates the deployment settings file needed by androiddeployqt.
\include cmake-find-package-core.qdocinc
\preliminarycmakecommand
\cmakecommandandroidonly

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

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

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

@ -34,6 +34,8 @@
\summary Handles various common platform-specific tasks associated with Qt targets.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

@ -34,6 +34,8 @@
\summary Calls moc on an input file.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

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

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

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

@ -34,6 +34,8 @@
\summary Creates .moc files from sources.
\include cmake-find-package-core.qdocinc
\section1 Synopsis
\badcode

5
src/corelib/doc/src/includes/cmake-find-package-core.qdocinc Normal file
View File

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

5
src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc Normal file
View File

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

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

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

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

@ -34,6 +34,8 @@
\summary Creates sources for .ui files.
\include cmake-find-package-widgets.qdocinc
\section1 Synopsis
\badcode

5
src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc Normal file
View File

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