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, 35 insertions, 36 deletions

diff --git a/find-modules/FindEGL.cmake b/find-modules/FindEGL.cmake
index 1350f630..7589dc74 100644
--- a/find-modules/FindEGL.cmake
+++ b/find-modules/FindEGL.cmake
@@ -1,43 +1,42 @@
-#.rst:
-# FindEGL
-# -------
-#
-# Try to find EGL.
-#
-# This will define the following variables:
-#
-# ``EGL_FOUND``
-#     True if (the requested version of) EGL is available
-# ``EGL_VERSION``
-#     The version of EGL; note that this is the API version defined in the
-#     headers, rather than the version of the implementation (eg: Mesa)
-# ``EGL_LIBRARIES``
-#     This can be passed to target_link_libraries() instead of the ``EGL::EGL``
-#     target
-# ``EGL_INCLUDE_DIRS``
-#     This should be passed to target_include_directories() if the target is not
-#     used for linking
-# ``EGL_DEFINITIONS``
-#     This should be passed to target_compile_options() if the target is not
-#     used for linking
-#
-# If ``EGL_FOUND`` is TRUE, it will also define the following imported target:
-#
-# ``EGL::EGL``
-#     The EGL 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: 2014 Martin Gräßlin <mgraesslin@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindEGL
+-------
+
+Try to find EGL.
+
+This will define the following variables:
+
+``EGL_FOUND``
+    True if (the requested version of) EGL is available
+``EGL_VERSION``
+    The version of EGL; note that this is the API version defined in the
+    headers, rather than the version of the implementation (eg: Mesa)
+``EGL_LIBRARIES``
+    This can be passed to target_link_libraries() instead of the ``EGL::EGL``
+    target
+``EGL_INCLUDE_DIRS``
+    This should be passed to target_include_directories() if the target is not
+    used for linking
+``EGL_DEFINITIONS``
+    This should be passed to target_compile_options() if the target is not
+    used for linking
+
+If ``EGL_FOUND`` is TRUE, it will also define the following imported target:
+
+``EGL::EGL``
+    The EGL 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)
 include(CheckCXXSourceCompiles)