diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2021-08-11 10:29:18 +0200 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2021-08-23 13:06:27 +0200 |
| commit | c3308b13ca1d21eb6119297341588d8df1242637 (patch) | |
| tree | 0befe9588d1d9760e6331146b8f9aac3fccf513d /src/dbus/doc/src | |
| parent | fd9a94594fc42347e1b08f83ae62e7d42aee1e6b (diff) | |
Doc: Add global \versionlessCMakeCommandsNote qdoc macro
When documenting a CMake command, document the unversioned command
'qt_foo' and use '\versionlessCMakeCommandNote qt6_foo' to refer to the
versioned command. This avoids duplicating the command signature.
Use the new macro where applicable.
Pick-to: 6.2
Task-number: QTBUG-95796
Change-Id: I2e4180fbda0b89acf3d8c036459f591eb2f46475
Reviewed-by: Craig Scott <craig.scott@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'src/dbus/doc/src')
| -rw-r--r-- | src/dbus/doc/src/qtdbus-cmake.qdoc | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index 0c8a253e19..f4432fb741 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -39,10 +39,10 @@ description file. \badcode qt_add_dbus_interface(<VAR> dbus_spec basename) - -qt6_add_dbus_interface(<VAR> dbus_spec basename) \endcode +\versionlessCMakeCommandsNote qt6_add_dbus_interface() + \section1 Description Generates C++ sources implementing an interface for a D-Bus interface description @@ -103,10 +103,10 @@ description files. \badcode qt_add_dbus_interfaces(<VAR> dbus_spec1 [dbus_spec2 ...]) - -qt6_add_dbus_interfaces(<VAR> dbus_spec1 [dbus_spec2 ...]) \endcode +\versionlessCMakeCommandsNote qt6_add_dbus_interfaces() + \section1 Description Generates C++ sources implementing D-Bus interfaces defined in \c{dbus_spec1}, @@ -162,13 +162,10 @@ qt_generate_dbus_interface(header [customName] [OPTIONS options] ) - -qt6_generate_dbus_interface(header - [customName] - [OPTIONS options] -) \endcode +\versionlessCMakeCommandsNote qt6_generate_dbus_interface() + \section1 Description Parses the C++ source or header file containing a QObject-derived class @@ -201,14 +198,10 @@ qt_add_dbus_adaptor(<VAR> dbus_spec header [basename] [classname] ) - -qt6_add_dbus_adaptor(<VAR> dbus_spec header - [parent_class] - [basename] - [classname] -) \endcode +\versionlessCMakeCommandsNote qt6_add_dbus_adaptor() + \section1 Description Generates a C++ header file implementing an adaptor for a D-Bus interface |