summaryrefslogtreecommitdiffstats
path: root/src/dbus/doc
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2020-10-05 15:58:24 +0200
committerKai Koehne <kai.koehne@qt.io>2020-10-25 10:49:59 +0200
commit66c94b83565d2db79307124b6cd797da33a5a7ef (patch)
treee223eff3e87c8dc4978bb1820ff5c71d7b21ba62 /src/dbus/doc
parentae18502151fff72885237897f1ffff79166e536c (diff)
CMake: Document versionless variants for CMake commands for DBus
Pick-to: 5.15 Change-Id: I7168a2d2589ef72d6e6f4bc568c5a914faa777df Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/dbus/doc')
-rw-r--r--src/dbus/doc/snippets/cmake/examples.cmake6
-rw-r--r--src/dbus/doc/src/qtdbus-cmake.qdoc46
2 files changed, 37 insertions, 15 deletions
diff --git a/src/dbus/doc/snippets/cmake/examples.cmake b/src/dbus/doc/snippets/cmake/examples.cmake
index cb4f86844f..3aa1f013bd 100644
--- a/src/dbus/doc/snippets/cmake/examples.cmake
+++ b/src/dbus/doc/snippets/cmake/examples.cmake
@@ -1,3 +1,3 @@
-#! [qt5_add_dbus_adaptor]
-qt5_add_dbus_adaptor(GENERATED_SOURCES org.example.chat.xml chat.h ChatMainWindow)
-#! [qt5_add_dbus_adaptor]
+#! [qt_add_dbus_adaptor]
+qt_add_dbus_adaptor(GENERATED_SOURCES org.example.chat.xml chat.h ChatMainWindow)
+#! [qt_add_dbus_adaptor]
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc
index 7130e4a262..bd7bc91f7c 100644
--- a/src/dbus/doc/src/qtdbus-cmake.qdoc
+++ b/src/dbus/doc/src/qtdbus-cmake.qdoc
@@ -26,10 +26,11 @@
****************************************************************************/
/*!
-\page qtdbus-cmake-qt5-add-dbus-interface.html
+\page qtdbus-cmake-qt-add-dbus-interface.html
\ingroup cmake-commands-qtdbus
-\title qt5_add_dbus_interface
+\title qt_add_dbus_interface
+\target qt5_add_dbus_interface
\brief Generates C++ sources implementing an interface for a D-Bus interface
description file.
@@ -37,6 +38,8 @@ description file.
\section1 Synopsis
\badcode
+qt_add_dbus_interface(<VAR> dbus_spec basename) # added in Qt 5.15
+
qt5_add_dbus_interface(<VAR> dbus_spec basename)
\endcode
@@ -87,10 +90,11 @@ Options can be set using \c set_source_file_property on the \c dbus_spec:
*/
/*!
-\page qtdbus-cmake-qt5-add-dbus-interfaces.html
+\page qtdbus-cmake-qt-add-dbus-interfaces.html
\ingroup cmake-commands-qtdbus
-\title qt5_add_dbus_interfaces
+\title qt_add_dbus_interfaces
+\target qt5_add_dbus_interface
\brief Generates C++ sources implementing interfaces for D-Bus interface
description files.
@@ -98,6 +102,8 @@ description files.
\section1 Synopsis
\badcode
+qt_add_dbus_interfaces(<VAR> dbus_spec1 [dbus_spec2 ...]) # added in Qt 5.15
+
qt5_add_dbus_interfaces(<VAR> dbus_spec1 [dbus_spec2 ...])
\endcode
@@ -141,16 +147,23 @@ arguments:
*/
/*!
-\page qtdbus-cmake-qt5-generate-dbus-interface.html
+\page qtdbus-cmake-qt-generate-dbus-interface.html
\ingroup cmake-commands-qtdbus
-\title qt5_generate_dbus_interface
+\title qt_generate_dbus_interface
+\target qt5_generate_dbus_interface
\brief Generates a D-Bus interface from a header file.
\section1 Synopsis
\badcode
+# added in Qt 5.15
+qt_generate_dbus_interface(header
+ [customName]
+ [OPTIONS options]
+)
+
qt5_generate_dbus_interface(header
[customName]
[OPTIONS options]
@@ -173,20 +186,29 @@ arguments to the tool can be set after \c{OPTIONS}.
*/
/*!
-\page qtdbus-cmake-qt5-add-dbus-adaptor.html
+\page qtdbus-cmake-qt-add-dbus-adaptor.html
\ingroup cmake-commands-qtdbus
-\title qt5_add_dbus_adaptor
+\title qt_add_dbus_adaptor
+\target qt5_add_dbus_adaptor
\brief Generates an adaptor class for a D-Bus interface.
\section1 Synopsis
\badcode
+# added in Qt 5.15
+qt_add_dbus_adaptor(<VAR> dbus_spec header
+ [parent_class]
+ [basename]
+ [classname]
+)
+
qt5_add_dbus_adaptor(<VAR> dbus_spec header
- [parent_class]
- [basename]
- [classname])
+ [parent_class]
+ [basename]
+ [classname]
+)
\endcode
\section1 Description
@@ -221,5 +243,5 @@ argument.
\section1 Examples
-\snippet cmake/examples.cmake qt5_add_dbus_adaptor
+\snippet cmake/examples.cmake qt_add_dbus_adaptor
*/