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

diff --git a/kde-modules/KDEClangFormat.cmake b/kde-modules/KDEClangFormat.cmake
index 7889fde0..9fd467e8 100644
--- a/kde-modules/KDEClangFormat.cmake
+++ b/kde-modules/KDEClangFormat.cmake
@@ -1,54 +1,54 @@
-#.rst:
-# KDEClangFormat
-# --------------------
-#
-# This module provides a functionality to format the source
-# code of your repository according to a predefined KDE
-# clang-format file.
-#
-# This module provides the following function:
-#
-# ::
-#
-#   kde_clang_format(<files>)
-#
-# Using this function will create a clang-format target that will format all
-# ``<files>`` passed to the function with the predefined KDE clang-format style.
-# To format the files you have to invoke the target with ``make clang-format`` or ``ninja clang-format``.
-# Once the project is formatted it is recommended to enforce the formatting using a pre-commit hook,
-# this can be done using :kde-module:`KDEGitCommitHooks`.
-#
-# The ``.clang-format`` file from ECM will be copied to the source directory. This file should not be
-# added to version control. It is recommended to add it to the ``.gitignore`` file: ``/.clang-format``.
-#
-# Since 5.79: If the source folder already contains a .clang-format file it is not overwritten.
-# Since version 5.80 this function is called by default in KDEFrameworkCompilerSettings. If directories should be excluded from
-# the formatting a .clang-format file with "DisableFormat: true" and "SortIncludes: false" should be created.
-#
-# Example usage:
-#
-# .. code-block:: cmake
-#
-#   include(KDEClangFormat)
-#   file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h)
-#   kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
-#
-# To exclude directories from the formatting add a ``.clang-format``
-# file in the directory with the following contents:
-#
-# .. code-block:: yaml
-#
-#    DisableFormat: true
-#    SortIncludes: false
-#
-# Since 5.64
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2019 Christoph Cullmann <cullmann@kde.org>
 # SPDX-FileCopyrightText: 2021 Alexander Lohnau <alexander.lohnau@gmx.de>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
+#[=======================================================================[.rst:
+KDEClangFormat
+--------------------
+
+This module provides a functionality to format the source
+code of your repository according to a predefined KDE
+clang-format file.
+
+This module provides the following function:
+
+::
+
+  kde_clang_format(<files>)
+
+Using this function will create a clang-format target that will format all
+``<files>`` passed to the function with the predefined KDE clang-format style.
+To format the files you have to invoke the target with ``make clang-format`` or ``ninja clang-format``.
+Once the project is formatted it is recommended to enforce the formatting using a pre-commit hook,
+this can be done using :kde-module:`KDEGitCommitHooks`.
+
+The ``.clang-format`` file from ECM will be copied to the source directory. This file should not be
+added to version control. It is recommended to add it to the ``.gitignore`` file: ``/.clang-format``.
+
+Since 5.79: If the source folder already contains a .clang-format file it is not overwritten.
+Since version 5.80 this function is called by default in KDEFrameworkCompilerSettings. If directories should be excluded from
+the formatting a .clang-format file with "DisableFormat: true" and "SortIncludes: false" should be created.
+
+Example usage:
+
+.. code-block:: cmake
+
+  include(KDEClangFormat)
+  file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h)
+  kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
+
+To exclude directories from the formatting add a ``.clang-format``
+file in the directory with the following contents:
+
+.. code-block:: yaml
+
+   DisableFormat: true
+   SortIncludes: false
+
+Since 5.64
+#]=======================================================================]
+
 # try to find clang-format in path
 find_program(KDE_CLANG_FORMAT_EXECUTABLE clang-format)