From 214afbdddffc434414cc619557dd6426263f8193 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20K=C3=B6hne?= Date: Fri, 24 Sep 2021 07:50:24 +0200 Subject: Doc: Make it explicit when CMake API is defined Task-number: QTBUG-96239 Pick-to: 6.2 Change-Id: Iaa99024f98f5422aa39f148a89594186b40344bf Reviewed-by: Edward Welbourne Reviewed-by: Paul Wicking --- src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc | 5 +++++ src/dbus/doc/src/qtdbus-cmake.qdoc | 8 ++++++++ 2 files changed, 13 insertions(+) create mode 100644 src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc (limited to 'src/dbus') 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 -- cgit v1.2.3