diff options
author | Alexandru Croitor <alexandru.croitor@qt.io> | 2022-01-31 17:53:50 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-02-15 22:19:48 +0000 |
commit | 2aa2a06d74c30d53684ac708d49b12d92280e6dc (patch) | |
tree | 8cb4acf42aaffbb073468e3805897ada0a588e40 /src/dbus/doc | |
parent | 7b5095347dc686b36059115b05d59a2ce64eed39 (diff) |
CMake: Document source file properties
Task-number: QTBUG-100224
Change-Id: Id4d0e0d84762d9eee2beb10e850d1775ad4f3245
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
(cherry picked from commit 1559cd8ff23b46a1e708f5d0093100acb9877028)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/dbus/doc')
-rw-r--r-- | src/dbus/doc/src/qtdbus-cmake.qdoc | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index 885ea62047..20daf42abb 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -266,3 +266,64 @@ argument. \snippet cmake/examples.cmake qt_add_dbus_adaptor */ + +/*! +\group cmake-source-file-properties-qtdbus +\title CMake Source File Properties in Qt6 DBus + +\l{CMake Commands in Qt6 DBus}{CMake Commands} know about the following CMake +source file properties: + +\sa{CMake Property Reference} +*/ + +/*! +\page cmake-source-file-property-CLASSNAME.html +\ingroup cmake-source-file-properties-qtdbus + +\title CLASSNAME +\target cmake-source-file-property-CLASSNAME + +\summary {Overrides the default interface class name.} + +\cmakepropertysince 5.0 + +When this property is set, the generated C++ class name is overridden +with the provided property value. + +\sa{qt6_add_dbus_interface}{qt_add_dbus_interface} +*/ + +/*! +\page cmake-source-file-property-INCLUDE.html +\ingroup cmake-source-file-properties-qtdbus + +\title INCLUDE +\target cmake-source-file-property-INCLUDE + +\summary {Adds an include path.} + +\cmakepropertysince 5.0 + +When this property is set, an #include "path" is added +to the generated C++ file. + +\sa{qt6_add_dbus_interface}{qt_add_dbus_interface} +*/ + +/*! +\page cmake-source-file-property-NO_NAMESPACE.html +\ingroup cmake-source-file-properties-qtdbus + +\title NO_NAMESPACE +\target cmake-source-file-property-NO_NAMESPACE + +\summary {Disables generation of a namespaced name.} + +\cmakepropertysince 5.0 + +When this property is set, the generated C++ class will not contain a namespaced alias. + +\sa{qt6_add_dbus_interface}{qt_add_dbus_interface} +*/ + |