diff options
Diffstat (limited to 'src/dbus/doc/src/qtdbus-cmake.qdoc')
-rw-r--r-- | src/dbus/doc/src/qtdbus-cmake.qdoc | 170 |
1 files changed, 116 insertions, 54 deletions
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index 0c8a253e19..86807af6e5 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -1,48 +1,43 @@ -/**************************************************************************** -** -** Copyright (C) 2019 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! +\group cmake-commands-qtdbus +\title CMake Commands in Qt6 DBus +\brief Lists CMake commands defined in Qt6::DBus. + +The following CMake commands are defined when Qt6::DBus is loaded, for instance +with + +\code +find_package(Qt6 REQUIRED COMPONENTS DBus) +\endcode + +\sa{CMake Command Reference} +*/ /*! \page qtdbus-cmake-qt-add-dbus-interface.html \ingroup cmake-commands-qtdbus \title qt_add_dbus_interface -\target qt6_add_dbus_interface +\keyword qt6_add_dbus_interface + +\summary {Generates C++ sources implementing an interface for a D-Bus interface +description file.} -\brief Generates C++ sources implementing an interface for a D-Bus interface -description file. +\include cmake-find-package-dbus.qdocinc + +\cmakecommandsince 6.0 \section1 Synopsis \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 @@ -67,7 +62,7 @@ class named after the interface name, with a namespaced alias: \section1 Options -Options can be set using \c set_source_file_property on the \c dbus_spec: +Options can be set using \c set_source_files_properties on the \c dbus_spec: \table \header @@ -94,19 +89,23 @@ Options can be set using \c set_source_file_property on the \c dbus_spec: \ingroup cmake-commands-qtdbus \title qt_add_dbus_interfaces -\target qt6_add_dbus_interface +\keyword qt6_add_dbus_interfaces + +\summary {Generates C++ sources implementing interfaces for D-Bus interface +description files.} -\brief Generates C++ sources implementing interfaces for D-Bus interface -description files. +\include cmake-find-package-dbus.qdocinc + +\cmakecommandsince 6.0 \section1 Synopsis \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}, @@ -123,7 +122,7 @@ The generated C++ source files are named after the XML file: For the file \section1 Options -Options can be set using \c set_source_file_property on each of the file +Options can be set using \c set_source_files_properties on each of the file arguments: \table @@ -151,9 +150,13 @@ arguments: \ingroup cmake-commands-qtdbus \title qt_generate_dbus_interface -\target qt6_generate_dbus_interface +\keyword qt6_generate_dbus_interface -\brief Generates a D-Bus interface from a header file. +\summary {Generates a D-Bus interface from a header file.} + +\include cmake-find-package-dbus.qdocinc + +\cmakecommandsince 6.0 \section1 Synopsis @@ -162,17 +165,14 @@ 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 -declaration and generates a file containing the D-BUS Introspection XML. +declaration and generates a file containing the D-Bus Introspection XML. By default, the generated XML file is stored in the current binary directory, and has the same base name as the header. You can specify a different name or @@ -189,9 +189,13 @@ arguments to the tool can be set after \c{OPTIONS}. \ingroup cmake-commands-qtdbus \title qt_add_dbus_adaptor -\target qt6_add_dbus_adaptor +\keyword qt6_add_dbus_adaptor + +\summary {Generates an adaptor class for a D-Bus interface.} -\brief Generates an adaptor class for a D-Bus interface. +\include cmake-find-package-dbus.qdocinc + +\cmakecommandsince 6.0 \section1 Synopsis @@ -201,14 +205,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 @@ -243,3 +243,65 @@ argument. \snippet cmake/examples.cmake qt_add_dbus_adaptor */ + +/*! +\group cmake-source-file-properties-qtdbus +\title CMake Source File Properties in Qt6 DBus +\brief Lists CMake file properties used 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} +*/ + |