diff options
| author | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2024-02-08 08:51:27 +0100 |
|---|---|---|
| committer | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2024-02-13 11:51:12 +0100 |
| commit | 50d2717f2d69388bca3df91f6be2d6a6c535947a (patch) | |
| tree | 894a8d20a8d9b9250dc4c626e5b90570b458780e /examples | |
| parent | 7e6d6f207b54af9c397a0b2bbc380a02d2975ce0 (diff) | |
doc: Add documentation for cmake functions
This adds documentation for the cmake functions used to generate
binding code for protocol extensions. Since the Wayland Client
library did not have any documentation landing page, it also
adds that. This currently only links to the cmake function, but
it can be extended to include other APIs later if we add them.
Pick-to: 6.7
Fixes: QTBUG-114147
Change-Id: I07d8dbe3bc32e5845482fe3e69ec6ba94897331b
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/wayland/custom-extension/doc/src/custom-extension.qdoc | 4 | ||||
| -rw-r--r-- | examples/wayland/custom-shell/doc/src/custom-shell.qdoc | 6 |
2 files changed, 8 insertions, 2 deletions
diff --git a/examples/wayland/custom-extension/doc/src/custom-extension.qdoc b/examples/wayland/custom-extension/doc/src/custom-extension.qdoc index 1da68f5d6..7b2cb0802 100644 --- a/examples/wayland/custom-extension/doc/src/custom-extension.qdoc +++ b/examples/wayland/custom-extension/doc/src/custom-extension.qdoc @@ -50,8 +50,8 @@ * becomes a call to a virtual function which can be implemented to provide the actual response. * * In order to have \c qtwaylandscanner run automatically as part of the build, we use the - * CMake functions \c qt6_generate_wayland_protocol_server_sources() and - * \c qt6_generate_wayland_protocol_client_sources() for generating the server-side and + * CMake functions \l{qt_generate_wayland_protocol_server_sources}{qt_generate_wayland_protocol_server_sources()} and + * \l{qt_generate_wayland_protocol_client_sources}{qt_generate_wayland_protocol_client_sources()} for generating the server-side and * client-side glue code, respectively. (When using \c qmake, the \c WAYLANDSERVERSOURCES and * \c WAYLANDCLIENTSOURCES variables achieve the same.) * diff --git a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc index b4938c03e..ba0fd8bf7 100644 --- a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc +++ b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc @@ -38,6 +38,12 @@ * \li An event informing the client of the shell surface's current minimized state. * \endlist * + * In order to have \c qtwaylandscanner run automatically as part of the build, we use the + * CMake functions \l{qt_generate_wayland_protocol_server_sources}{qt_generate_wayland_protocol_server_sources()} and + * \l{qt_generate_wayland_protocol_client_sources}{qt_generate_wayland_protocol_client_sources()} for generating the server-side and + * client-side glue code, respectively. (When using \c qmake, the \c WAYLANDSERVERSOURCES and + * \c WAYLANDCLIENTSOURCES variables achieve the same.) + * * \section1 The Client Plugin * * In order for the shell integration to be discovered by a Qt client, we must reimplement |