CMake: Document versionless variants for CMake commands for DBus

Pick-to: 5.15
Change-Id: I7168a2d2589ef72d6e6f4bc568c5a914faa777df
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Kai Koehne 2020-10-05 15:58:24 +02:00
parent ae18502151
commit 66c94b8356
2 changed files with 37 additions and 15 deletions

View File

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

View File

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