path: root/src/dbus/doc
diff options
Diffstat (limited to 'src/dbus/doc')
5 files changed, 39 insertions, 8 deletions
diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf
index 35f17b1f34..b23c5fb121 100644
--- a/src/dbus/doc/qtdbus.qdocconf
+++ b/src/dbus/doc/qtdbus.qdocconf
@@ -66,3 +66,6 @@ navigation.cppclassespage = "Qt D-Bus C++ Classes"
manifestmeta.thumbnail.names = "QtDBus/D-Bus List Names Example" \
"QtDBus/D-Bus Ping Pong Example" \
"QtDBus/D-Bus Complex Ping Pong Example"
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
diff --git a/src/dbus/doc/src/dbus-adaptors.qdoc b/src/dbus/doc/src/dbus-adaptors.qdoc
index d2a5ac27a8..68cacf8e64 100644
--- a/src/dbus/doc/src/dbus-adaptors.qdoc
+++ b/src/dbus/doc/src/dbus-adaptors.qdoc
@@ -190,7 +190,7 @@
The delayed reply itself is requested from Qt D-Bus by calling
QDBusMessage::reply() on the original message. It then becomes the
- resposibility of the called code to eventually send a reply to the
+ responsibility of the called code to eventually send a reply to the
\warning When a caller places a method call and waits for a reply, it will
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:
+find_package(Qt6 COMPONENTS DBus REQUIRED)
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc
index f4432fb741..92b0e700ff 100644
--- a/src/dbus/doc/src/qtdbus-cmake.qdoc
+++ b/src/dbus/doc/src/qtdbus-cmake.qdoc
@@ -26,14 +26,30 @@
+\group cmake-commands-qtdbus
+\title CMake Commands in Qt6 DBus
+The following CMake commands are defined when Qt6::DBus is loaded, for instance
+find_package(Qt6 COMPONENTS DBus REQUIRED)
+\sa{CMake Command Reference}
\page qtdbus-cmake-qt-add-dbus-interface.html
\ingroup cmake-commands-qtdbus
\title qt_add_dbus_interface
\target qt6_add_dbus_interface
-\brief 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
\section1 Synopsis
@@ -94,10 +110,12 @@ Options can be set using \c set_source_file_property on the \c dbus_spec:
\ingroup cmake-commands-qtdbus
\title qt_add_dbus_interfaces
-\target qt6_add_dbus_interface
+\target qt6_add_dbus_interfaces
-\brief 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
\section1 Synopsis
@@ -153,7 +171,9 @@ arguments:
\title qt_generate_dbus_interface
\target qt6_generate_dbus_interface
-\brief 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
\section1 Synopsis
@@ -188,7 +208,9 @@ arguments to the tool can be set after \c{OPTIONS}.
\title qt_add_dbus_adaptor
\target qt6_add_dbus_adaptor
-\brief 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
\section1 Synopsis
diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc
index afd70c2f7c..dd03ba595f 100644
--- a/src/dbus/doc/src/qtdbus-index.qdoc
+++ b/src/dbus/doc/src/qtdbus-index.qdoc
@@ -239,6 +239,7 @@
\li \l{The Qt D-Bus Type System}
\li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
\li \l{Qt D-Bus C++ Classes}
+ \li \l{CMake Commands in Qt6 DBus}
\li \l{Qt D-Bus Examples}
\li \l{D-Bus Viewer}