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, 19 insertions, 19 deletions

diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake
index 16ecc2a5..7a96280e 100644
--- a/modules/ECMCoverageOption.cmake
+++ b/modules/ECMCoverageOption.cmake
@@ -1,26 +1,26 @@
-#.rst:
-# ECMCoverageOption
-# --------------------
-#
-# Allow users to easily enable GCov code coverage support.
-#
-# Code coverage allows you to check how much of your codebase is covered by
-# your tests. This module makes it easy to build with support for
-# `GCov <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_.
-#
-# When this module is included, a ``BUILD_COVERAGE`` option is added (default
-# OFF). Turning this option on enables GCC's coverage instrumentation, and
-# links against ``libgcov``.
-#
-# Note that this will probably break the build if you are not using GCC.
-#
-# Since 1.3.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2014 Aleix Pol Gonzalez <aleixpol@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
+#[=======================================================================[.rst:
+ECMCoverageOption
+--------------------
+
+Allow users to easily enable GCov code coverage support.
+
+Code coverage allows you to check how much of your codebase is covered by
+your tests. This module makes it easy to build with support for
+`GCov <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_.
+
+When this module is included, a ``BUILD_COVERAGE`` option is added (default
+OFF). Turning this option on enables GCC's coverage instrumentation, and
+links against ``libgcov``.
+
+Note that this will probably break the build if you are not using GCC.
+
+Since 1.3.0.
+#]=======================================================================]
+
 option(BUILD_COVERAGE "Build the project with gcov support" OFF)
 
 if(BUILD_COVERAGE)