CMake: Document source file properties

Pick-to: 6.2 6.3
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>
This commit is contained in:
Alexandru Croitor 2022-01-31 17:53:50 +01:00
parent e044c94a61
commit 1559cd8ff2
2 changed files with 89 additions and 0 deletions

View File

@ -356,3 +356,31 @@ When using \l{qt6_add_resources}{qt_add_resources} without a \c PREFIX
argument, then the value of this target property will be used as
resource prefix.
*/
/*!
\group cmake-source-file-properties-qtcore
\title CMake Source File Properties in Qt6 Core
\l{CMake Commands in Qt6 Core}{CMake Commands} know about the following CMake
source file properties:
\sa{CMake Property Reference}
*/
/*!
\page cmake-source-file-property-QT_RESOURCE_ALIAS.html
\ingroup cmake-source-file-properties-qtcore
\title QT_RESOURCE_ALIAS
\target cmake-source-file-property-QT_RESOURCE_ALIAS
\summary {Specifies the Qt resource alias for a file in a resource.}
\cmakepropertysince 6.0
\preliminarycmakeproperty
When using the target-based variant of \l{qt6_add_resources}{qt_add_resources}
the property value overrides the runtime path where the resource file is found.
\sa{The Qt Resource System}
*/

View File

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