diff options
Diffstat (limited to 'src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc')
| -rw-r--r-- | src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc b/src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc index 97a7f7ed4..43f448fbd 100644 --- a/src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc +++ b/src/client/doc/src/cmake/qt_generate_wayland_protocol_client_sources.qdoc @@ -23,6 +23,7 @@ find_package(Qt6 REQUIRED COMPONENTS WaylandClient) \badcode qt_generate_wayland_protocol_client_sources(target + [PUBLIC_CODE | PRIVATE_CODE] FILES file1.xml [file2.xml ...]) \endcode @@ -30,11 +31,15 @@ qt_generate_wayland_protocol_client_sources(target \section1 Description -qt_generate_wayland_protocol_client_sources() creates the build steps to run \c{waylandscanner} and +qt_generate_wayland_protocol_client_sources() creates the build steps to run \c{wayland-scanner} and \c{qtwaylandscanner} on one or more Wayland protocol files. The tools will in turn generate binding code in C and C++ for implementing the protocols, and the resulting files will be built as part of the \c target. +The options \c{PUBLIC_CODE} and \c{PRIVATE_CODE} correspond to the \c{public-code} and +\c{private-code} options of \c{wayland-scanner}. For backwards compatibility \c{PUBLIC_CODE} is the +default but generally \c{PRIVATE_CODE} is strongly recommended. + qt_generate_wayland_protocol_client_sources() will trigger generation of the files needed to implement the client side of the protocol. \l{qt_generate_wayland_protocol_server_sources}{qt_generate_wayland_protocol_server_sources()} is the equivalent function for the compositor. |