From 5512e03562694ebfe571a3b6068a7d35d9ddfd7a Mon Sep 17 00:00:00 2001
From: "Friedrich W. H. Kossebau" <kossebau@kde.org>
Date: Sat, 17 Apr 2021 11:02:00 +0200
Subject: 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
---
 modules/ECMConfiguredInstall.cmake | 58 ++++++++++++++++++--------------------
 1 file changed, 28 insertions(+), 30 deletions(-)

(limited to 'modules/ECMConfiguredInstall.cmake')

diff --git a/modules/ECMConfiguredInstall.cmake b/modules/ECMConfiguredInstall.cmake
index b2d8374b..e3e77312 100644
--- a/modules/ECMConfiguredInstall.cmake
+++ b/modules/ECMConfiguredInstall.cmake
@@ -1,37 +1,35 @@
-#.rst:
-# ECMConfiguredInstall
-# --------------------
-#
-# Takes a list of files, runs configure_file on each and installs the resultant configured files in the given location.
-#
-# Any suffix of ".in" in the passed file names wil be stripped from the file name at the installed location.
-#
-# ::
-#
-#   ecm_install_configured_files(
-#       INPUT <file> [<file2> [...]]
-#       DESTINATION <INSTALL_DIRECTORY>
-#       [COPYONLY]
-#       [ESCAPE_QUOTES]
-#       [@ONLY]
-#       [COMPONENT <component>])
-#
-# Example usage:
-#
-# .. code-block:: cmake
-#
-#   ecm_install_configured_files(INPUT foo.txt.in DESTINATION ${KDE_INSTALL_DATADIR} @ONLY)
-#
-# This wil install the file as foo.txt with any cmake variable replacements made into the data directory.
-#
-# Since 5.73.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2020 David Edmundson <davidedmundson@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
 
+#[=======================================================================[.rst:
+ECMConfiguredInstall
+--------------------
+
+Takes a list of files, runs configure_file on each and installs the resultant configured files in the given location.
+
+Any suffix of ".in" in the passed file names wil be stripped from the file name at the installed location.
+
+::
+
+  ecm_install_configured_files(
+      INPUT <file> [<file2> [...]]
+      DESTINATION <INSTALL_DIRECTORY>
+      [COPYONLY]
+      [ESCAPE_QUOTES]
+      [@ONLY]
+      [COMPONENT <component>])
+
+Example usage:
+
+.. code-block:: cmake
+
+  ecm_install_configured_files(INPUT foo.txt.in DESTINATION ${KDE_INSTALL_DATADIR} @ONLY)
+
+This will install the file as foo.txt with any cmake variable replacements made into the data directory.
+
+Since 5.73.0.
+#]=======================================================================]
 
 function(ecm_install_configured_files)
     set(options COPYONLY ESCAPE_QUOTES @ONLY)
-- 
cgit v1.2.1