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

1 files changed, 36 insertions, 37 deletions

diff --git a/find-modules/FindX11_XCB.cmake b/find-modules/FindX11_XCB.cmake
index 589e2560..a04d1c37 100644
--- a/find-modules/FindX11_XCB.cmake
+++ b/find-modules/FindX11_XCB.cmake
@@ -1,46 +1,45 @@
-#.rst:
-# FindX11_XCB
-# -----------
-#
-# Try to find the X11 XCB compatibility library.
-#
-# This will define the following variables:
-#
-# ``X11_XCB_FOUND``
-#     True if (the requested version of) libX11-xcb is available
-# ``X11_XCB_VERSION``
-#     The version of libX11-xcb (this is not guaranteed to be set even when
-#     X11_XCB_FOUND is true)
-# ``X11_XCB_LIBRARIES``
-#     This can be passed to target_link_libraries() instead of the ``EGL::EGL``
-#     target
-# ``X11_XCB_INCLUDE_DIR``
-#     This should be passed to target_include_directories() if the target is not
-#     used for linking
-# ``X11_XCB_DEFINITIONS``
-#     This should be passed to target_compile_options() if the target is not
-#     used for linking
-#
-# If ``X11_XCB_FOUND`` is TRUE, it will also define the following imported
-# target:
-#
-# ``X11::XCB``
-#     The X11 XCB compatibility library
-#
-# In general we recommend using the imported target, as it is easier to use.
-# Bear in mind, however, that if the target is in the link interface of an
-# exported library, it must be made available by the package config file.
-#
-# Since pre-1.0.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kde.org>
 # SPDX-FileCopyrightText: 2011 Fredrik Höglund <fredrik@kde.org>
 # SPDX-FileCopyrightText: 2008 Helio Chissini de Castro <helio@kde.org>
 # SPDX-FileCopyrightText: 2007 Matthias Kretz <kretz@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindX11_XCB
+-----------
+
+Try to find the X11 XCB compatibility library.
+
+This will define the following variables:
+
+``X11_XCB_FOUND``
+    True if (the requested version of) libX11-xcb is available
+``X11_XCB_VERSION``
+    The version of libX11-xcb (this is not guaranteed to be set even when
+    X11_XCB_FOUND is true)
+``X11_XCB_LIBRARIES``
+    This can be passed to target_link_libraries() instead of the ``EGL::EGL``
+    target
+``X11_XCB_INCLUDE_DIR``
+    This should be passed to target_include_directories() if the target is not
+    used for linking
+``X11_XCB_DEFINITIONS``
+    This should be passed to target_compile_options() if the target is not
+    used for linking
+
+If ``X11_XCB_FOUND`` is TRUE, it will also define the following imported
+target:
+
+``X11::XCB``
+    The X11 XCB compatibility library
+
+In general we recommend using the imported target, as it is easier to use.
+Bear in mind, however, that if the target is in the link interface of an
+exported library, it must be made available by the package config file.
+
+Since pre-1.0.0.
+#]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake)