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

diff --git a/modules/ECMUninstallTarget.cmake b/modules/ECMUninstallTarget.cmake
index 4fe049ff..7298012d 100644
--- a/modules/ECMUninstallTarget.cmake
+++ b/modules/ECMUninstallTarget.cmake
@@ -1,40 +1,40 @@
-#.rst:
-# ECMUninstallTarget
-# ------------------
-#
-# Add an ``uninstall`` target.
-#
-# By including this module, an ``uninstall`` target will be added to your CMake
-# project. This will remove all files installed (or updated) by a previous
-# invocation of the ``install`` target. It will not remove files created or
-# modified by an ``install(SCRIPT)`` or ``install(CODE)`` command; you should
-# create a custom uninstallation target for these and use ``add_dependency`` to
-# make the ``uninstall`` target depend on it:
-#
-# .. code-block:: cmake
-#
-#   include(ECMUninstallTarget)
-#   install(SCRIPT install-foo.cmake)
-#   add_custom_target(uninstall_foo COMMAND ${CMAKE_COMMAND} -P uninstall-foo.cmake)
-#   add_dependency(uninstall uninstall_foo)
-#
-# The target will fail if the ``install`` target has not yet been run (so it is
-# not possible to run CMake on the project and then immediately run the
-# ``uninstall`` target).
-#
-# .. warning::
-#
-#   CMake deliberately does not provide an ``uninstall`` target by default on
-#   the basis that such a target has the potential to remove important files
-#   from a user's computer. Use with caution.
-#
-# Since 1.7.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2015 Alex Merry <alex.merry@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
+#[=======================================================================[.rst:
+ECMUninstallTarget
+------------------
+
+Add an ``uninstall`` target.
+
+By including this module, an ``uninstall`` target will be added to your CMake
+project. This will remove all files installed (or updated) by a previous
+invocation of the ``install`` target. It will not remove files created or
+modified by an ``install(SCRIPT)`` or ``install(CODE)`` command; you should
+create a custom uninstallation target for these and use ``add_dependency`` to
+make the ``uninstall`` target depend on it:
+
+.. code-block:: cmake
+
+  include(ECMUninstallTarget)
+  install(SCRIPT install-foo.cmake)
+  add_custom_target(uninstall_foo COMMAND ${CMAKE_COMMAND} -P uninstall-foo.cmake)
+  add_dependency(uninstall uninstall_foo)
+
+The target will fail if the ``install`` target has not yet been run (so it is
+not possible to run CMake on the project and then immediately run the
+``uninstall`` target).
+
+.. warning::
+
+  CMake deliberately does not provide an ``uninstall`` target by default on
+  the basis that such a target has the potential to remove important files
+  from a user's computer. Use with caution.
+
+Since 1.7.0.
+#]=======================================================================]
+
 if (NOT TARGET uninstall)
     configure_file(
         "${CMAKE_CURRENT_LIST_DIR}/ecm_uninstall.cmake.in"