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/ECMMarkNonGuiExecutable.cmake | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

(limited to 'modules/ECMMarkNonGuiExecutable.cmake')

diff --git a/modules/ECMMarkNonGuiExecutable.cmake b/modules/ECMMarkNonGuiExecutable.cmake
index fb073e1b..48b4feaa 100644
--- a/modules/ECMMarkNonGuiExecutable.cmake
+++ b/modules/ECMMarkNonGuiExecutable.cmake
@@ -1,24 +1,24 @@
-#.rst:
-# ECMMarkNonGuiExecutable
-# -----------------------
-#
-# Marks an executable target as not being a GUI application.
-#
-# ::
-#
-#   ecm_mark_nongui_executable(<target1> [<target2> [...]])
-#
-# This will indicate to CMake that the specified targets should not be included
-# in a MACOSX_BUNDLE and should not be WIN32_EXECUTABLEs.  On platforms other
-# than MacOS X or Windows, this will have no effect.
-#
-# Since pre-1.0.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2012 Stephen Kelly <steveire@gmail.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
+#[=======================================================================[.rst:
+ECMMarkNonGuiExecutable
+-----------------------
+
+Marks an executable target as not being a GUI application.
+
+::
+
+  ecm_mark_nongui_executable(<target1> [<target2> [...]])
+
+This will indicate to CMake that the specified targets should not be included
+in a MACOSX_BUNDLE and should not be WIN32_EXECUTABLEs.  On platforms other
+than MacOS X or Windows, this will have no effect.
+
+Since pre-1.0.0.
+#]=======================================================================]
+
 function(ecm_mark_nongui_executable)
   foreach(_target ${ARGN})
     set_target_properties(${_target}
-- 
cgit v1.2.1