From 5512e03562694ebfe571a3b6068a7d35d9ddfd7a Mon Sep 17 00:00:00 2001
From: "Friedrich W. H. Kossebau" <kossebau@kde.org>
Date: Sat, 17 Apr 2021 11:02:00 +0200
Subject: 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
---
 find-modules/FindQtWaylandScanner.cmake | 123 ++++++++++++++++----------------
 1 file changed, 61 insertions(+), 62 deletions(-)

(limited to 'find-modules/FindQtWaylandScanner.cmake')

diff --git a/find-modules/FindQtWaylandScanner.cmake b/find-modules/FindQtWaylandScanner.cmake
index efbbe87a..684ea8b8 100644
--- a/find-modules/FindQtWaylandScanner.cmake
+++ b/find-modules/FindQtWaylandScanner.cmake
@@ -1,68 +1,67 @@
-#.rst:
-# FindQtWaylandScanner
-# --------------------
-#
-# Try to find qtwaylandscanner.
-#
-# If the qtwaylandscanner executable is not in your PATH, you can provide
-# an alternative name or full path location with the ``QtWaylandScanner_EXECUTABLE``
-# variable.
-#
-# This will define the following variables:
-#
-# ``QtWaylandScanner_FOUND``
-#     True if qtwaylandscanner is available
-#
-# ``QtWaylandScanner_EXECUTABLE``
-#     The qtwaylandscanner executable.
-#
-# If ``QtWaylandScanner_FOUND`` is TRUE, it will also define the following imported
-# target:
-#
-# ``Wayland::QtScanner``
-#     The qtwaylandscanner executable.
-#
-# This module provides the following functions to generate C++ protocol
-# implementations:
-#
-#   - ``ecm_add_qtwayland_client_protocol``
-#   - ``ecm_add_qtwayland_server_protocol``
-#
-# ::
-#
-#   ecm_add_qtwayland_client_protocol(<source_files_var>
-#                                     PROTOCOL <xmlfile>
-#                                     BASENAME <basename>
-#                                     [PREFIX <prefix>])
-#
-# Generate C++ wrapper to Wayland client protocol files from ``<xmlfile>``
-# XML definition for the ``<basename>`` interface and append those files
-# to ``<source_files_var>``.  Pass the ``<prefix>`` argument if the interface
-# names don't start with ``qt_`` or ``wl_``.
-#
-# WaylandScanner is required and will be searched for.
-#
-# ::
-#
-#   ecm_add_qtwayland_server_protocol(<source_files_var>
-#                                     PROTOCOL <xmlfile>
-#                                     BASENAME <basename>
-#                                     [PREFIX <prefix>])
-#
-# Generate C++ wrapper to Wayland server protocol files from ``<xmlfile>``
-# XML definition for the ``<basename>`` interface and append those files
-# to ``<source_files_var>``.  Pass the ``<prefix>`` argument if the interface
-# names don't start with ``qt_`` or ``wl_``.
-#
-# WaylandScanner is required and will be searched for.
-#
-# Since 1.4.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2012-2014 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindQtWaylandScanner
+--------------------
+
+Try to find qtwaylandscanner.
+
+If the qtwaylandscanner executable is not in your PATH, you can provide
+an alternative name or full path location with the ``QtWaylandScanner_EXECUTABLE``
+variable.
+
+This will define the following variables:
+
+``QtWaylandScanner_FOUND``
+    True if qtwaylandscanner is available
+
+``QtWaylandScanner_EXECUTABLE``
+    The qtwaylandscanner executable.
+
+If ``QtWaylandScanner_FOUND`` is TRUE, it will also define the following imported
+target:
+
+``Wayland::QtScanner``
+    The qtwaylandscanner executable.
+
+This module provides the following functions to generate C++ protocol
+implementations:
+
+  - ``ecm_add_qtwayland_client_protocol``
+  - ``ecm_add_qtwayland_server_protocol``
+
+::
+
+  ecm_add_qtwayland_client_protocol(<source_files_var>
+                                    PROTOCOL <xmlfile>
+                                    BASENAME <basename>
+                                    [PREFIX <prefix>])
+
+Generate C++ wrapper to Wayland client protocol files from ``<xmlfile>``
+XML definition for the ``<basename>`` interface and append those files
+to ``<source_files_var>``.  Pass the ``<prefix>`` argument if the interface
+names don't start with ``qt_`` or ``wl_``.
+
+WaylandScanner is required and will be searched for.
+
+::
+
+  ecm_add_qtwayland_server_protocol(<source_files_var>
+                                    PROTOCOL <xmlfile>
+                                    BASENAME <basename>
+                                    [PREFIX <prefix>])
+
+Generate C++ wrapper to Wayland server protocol files from ``<xmlfile>``
+XML definition for the ``<basename>`` interface and append those files
+to ``<source_files_var>``.  Pass the ``<prefix>`` argument if the interface
+names don't start with ``qt_`` or ``wl_``.
+
+WaylandScanner is required and will be searched for.
+
+Since 1.4.0.
+#]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake)
 include("${ECM_MODULE_DIR}/ECMQueryQmake.cmake")
-- 
cgit v1.2.1