summaryrefslogtreecommitdiffstats
path: root/src/dbus/doc
diff options
context:
space:
mode:
authorKai Köhne <kai.koehne@qt.io>2021-09-24 07:50:24 +0200
committerKai Köhne <kai.koehne@qt.io>2021-10-05 15:48:22 +0200
commit214afbdddffc434414cc619557dd6426263f8193 (patch)
tree73ab6906c5fc09b4f8040a2b2eced33e1788bc25 /src/dbus/doc
parent5381f6c8773e00f6dee998ddfa9d8b711c45413a (diff)
Doc: Make it explicit when CMake API is defined
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>
Diffstat (limited to 'src/dbus/doc')
-rw-r--r--src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc5
-rw-r--r--src/dbus/doc/src/qtdbus-cmake.qdoc8
2 files changed, 13 insertions, 0 deletions
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