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, 30 insertions, 31 deletions

diff --git a/find-modules/FindCanberra.cmake b/find-modules/FindCanberra.cmake
index bda73aca..c54adf99 100644
--- a/find-modules/FindCanberra.cmake
+++ b/find-modules/FindCanberra.cmake
@@ -1,38 +1,37 @@
-#.rst:
-# FindCanberra
-# ------------
-#
-# Try to find Canberra event sound library.
-#
-# This will define the following variables:
-#
-# ``Canberra_FOUND``
-#     True if (the requested version of) Canberra is available
-# ``Canberra_VERSION``
-#     The version of Canberra
-# ``Canberra_LIBRARIES``
-#     The libraries of Canberra for use with target_link_libraries()
-# ``Canberra_INCLUDE_DIRS``
-#     The include dirs of Canberra for use with target_include_directories()
-#
-# If ``Canberra_FOUND`` is TRUE, it will also define the following imported
-# target:
-#
-# ``Canberra::Canberra``
-#     The Canberra 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 5.56.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2012 Raphael Kubo da Costa <rakuco@FreeBSD.org>
 # SPDX-FileCopyrightText: 2019 Harald Sitter <sitter@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindCanberra
+------------
+
+Try to find Canberra event sound library.
+
+This will define the following variables:
+
+``Canberra_FOUND``
+    True if (the requested version of) Canberra is available
+``Canberra_VERSION``
+    The version of Canberra
+``Canberra_LIBRARIES``
+    The libraries of Canberra for use with target_link_libraries()
+``Canberra_INCLUDE_DIRS``
+    The include dirs of Canberra for use with target_include_directories()
+
+If ``Canberra_FOUND`` is TRUE, it will also define the following imported
+target:
+
+``Canberra::Canberra``
+    The Canberra 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 5.56.0.
+#]=======================================================================]
 
 find_package(PkgConfig QUIET)
 pkg_check_modules(PC_Canberra libcanberra QUIET)