diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-17 11:02:00 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-23 17:49:14 +0000 |
| commit | 5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch) | |
| tree | 3caca041d3526c8427ec3065642b41a52ad8578c /find-modules/FindWaylandScanner.cmake | |
| parent | 38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff) | |
| download | extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2 | |
Modules docs: move rst docs into bracket comments
CMake >= 3.0 supports bracket comments, and the reStructuredText
integration code in sphinx/ext/ecm.py already supports extracting
the docs from a bracket comment instead.
Editing documentation without leading line comment markers is more simple,
e,g. when reflowing text over lines.
With ECM meanwhile requiring CMake 3.5 now it is possible to switch
(and thus follow also the approach used by cmake itself).
NO_CHANGELOG
Diffstat (limited to 'find-modules/FindWaylandScanner.cmake')
| -rw-r--r-- | find-modules/FindWaylandScanner.cmake | 107 |
1 files changed, 53 insertions, 54 deletions
diff --git a/find-modules/FindWaylandScanner.cmake b/find-modules/FindWaylandScanner.cmake index e0e68c45..7b493d81 100644 --- a/find-modules/FindWaylandScanner.cmake +++ b/find-modules/FindWaylandScanner.cmake @@ -1,60 +1,59 @@ -#.rst: -# FindWaylandScanner -# ------------------ -# -# Try to find wayland-scanner. -# -# If the wayland-scanner executable is not in your PATH, you can provide -# an alternative name or full path location with the ``WaylandScanner_EXECUTABLE`` -# variable. -# -# This will define the following variables: -# -# ``WaylandScanner_FOUND`` -# True if wayland-scanner is available. -# -# ``WaylandScanner_EXECUTABLE`` -# The wayland-scanner executable. -# -# If ``WaylandScanner_FOUND`` is TRUE, it will also define the following imported -# target: -# -# ``Wayland::Scanner`` -# The wayland-scanner executable. -# -# This module provides the following functions to generate C protocol -# implementations: -# -# - ``ecm_add_wayland_client_protocol`` -# - ``ecm_add_wayland_server_protocol`` -# -# :: -# -# ecm_add_wayland_client_protocol(<source_files_var> -# PROTOCOL <xmlfile> -# BASENAME <basename>) -# -# Generate Wayland client protocol files from ``<xmlfile>`` XML -# definition for the ``<basename>`` interface and append those files -# to ``<source_files_var>``. -# -# :: -# -# ecm_add_wayland_server_protocol(<source_files_var> -# PROTOCOL <xmlfile> -# BASENAME <basename>) -# -# Generate Wayland server protocol files from ``<xmlfile>`` XML -# definition for the ``<basename>`` interface and append those files -# to ``<source_files_var>``. -# -# Since 1.4.0. - -#============================================================================= # SPDX-FileCopyrightText: 2012-2014 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com> # # SPDX-License-Identifier: BSD-3-Clause -#============================================================================= + +#[=======================================================================[.rst: +FindWaylandScanner +------------------ + +Try to find wayland-scanner. + +If the wayland-scanner executable is not in your PATH, you can provide +an alternative name or full path location with the ``WaylandScanner_EXECUTABLE`` +variable. + +This will define the following variables: + +``WaylandScanner_FOUND`` + True if wayland-scanner is available. + +``WaylandScanner_EXECUTABLE`` + The wayland-scanner executable. + +If ``WaylandScanner_FOUND`` is TRUE, it will also define the following imported +target: + +``Wayland::Scanner`` + The wayland-scanner executable. + +This module provides the following functions to generate C protocol +implementations: + + - ``ecm_add_wayland_client_protocol`` + - ``ecm_add_wayland_server_protocol`` + +:: + + ecm_add_wayland_client_protocol(<source_files_var> + PROTOCOL <xmlfile> + BASENAME <basename>) + +Generate Wayland client protocol files from ``<xmlfile>`` XML +definition for the ``<basename>`` interface and append those files +to ``<source_files_var>``. + +:: + + ecm_add_wayland_server_protocol(<source_files_var> + PROTOCOL <xmlfile> + BASENAME <basename>) + +Generate Wayland server protocol files from ``<xmlfile>`` XML +definition for the ``<basename>`` interface and append those files +to ``<source_files_var>``. + +Since 1.4.0. +#]=======================================================================] include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake) |