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, 22 insertions, 23 deletions

diff --git a/find-modules/FindKF5.cmake b/find-modules/FindKF5.cmake
index c4221467..42c55bab 100644
--- a/find-modules/FindKF5.cmake
+++ b/find-modules/FindKF5.cmake
@@ -1,30 +1,29 @@
-#.rst:
-# FindKF5
-# -------
-#
-# Find KDE Frameworks 5 with a single find_package() call.
-#
-# This will use the package config files provided by the individual frameworks.
-# For example, if you wish to find KArchive, which presents itself to CMake as
-# KF5Archive (ie: you would do ``find_package(KF5Archive)`` to find it
-# directly), you can do
-#
-# .. code-block:: cmake
-#
-#   find_package(KF5 COMPONENTS Archive)
-#
-# If all the required components (those given in the COMPONENTS argument, but
-# not those given in the OPTIONAL_COMPONENTS argument) are found, ``KF5_FOUND``
-# will be set to true. Otherwise, it will be set to false.
-#
-# Since pre-1.0.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kde.org>
 # SPDX-FileCopyrightText: 2013 Stephen Kelly <steveire@gmail.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindKF5
+-------
+
+Find KDE Frameworks 5 with a single find_package() call.
+
+This will use the package config files provided by the individual frameworks.
+For example, if you wish to find KArchive, which presents itself to CMake as
+KF5Archive (ie: you would do ``find_package(KF5Archive)`` to find it
+directly), you can do
+
+.. code-block:: cmake
+
+  find_package(KF5 COMPONENTS Archive)
+
+If all the required components (those given in the COMPONENTS argument, but
+not those given in the OPTIONAL_COMPONENTS argument) are found, ``KF5_FOUND``
+will be set to true. Otherwise, it will be set to false.
+
+Since pre-1.0.0.
+#]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake)