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
---
 find-modules/FindSharedMimeInfo.cmake | 59 +++++++++++++++++------------------
 1 file changed, 29 insertions(+), 30 deletions(-)

(limited to 'find-modules/FindSharedMimeInfo.cmake')

diff --git a/find-modules/FindSharedMimeInfo.cmake b/find-modules/FindSharedMimeInfo.cmake
index 0b8dec9c..39fba669 100644
--- a/find-modules/FindSharedMimeInfo.cmake
+++ b/find-modules/FindSharedMimeInfo.cmake
@@ -1,37 +1,36 @@
-#.rst:
-# FindSharedMimeInfo
-# ------------------
-#
-# Try to find the shared-mime-info package.
-#
-# This will define the following variables:
-#
-# ``SharedMimeInfo_FOUND``
-#     True if system has the shared-mime-info package
-# ``UPDATE_MIME_DATABASE_EXECUTABLE``
-#     The update-mime-database executable
-#
-# and the following imported targets:
-#
-# ``SharedMimeInfo::UpdateMimeDatabase``
-#     The update-mime-database executable
-#
-# The follow macro is available::
-#
-#   update_xdg_mimetypes(<path>)
-#
-# Updates the XDG mime database at install time (unless the ``$DESTDIR``
-# environment variable is set, in which case it is up to package managers to
-# perform this task).
-#
-# Since pre-1.0.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2013-2014 Alex Merry <alex.merry@kdemail.net>
 # SPDX-FileCopyrightText: 2007 Pino Toscano <toscano.pino@tiscali.it>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindSharedMimeInfo
+------------------
+
+Try to find the shared-mime-info package.
+
+This will define the following variables:
+
+``SharedMimeInfo_FOUND``
+    True if system has the shared-mime-info package
+``UPDATE_MIME_DATABASE_EXECUTABLE``
+    The update-mime-database executable
+
+and the following imported targets:
+
+``SharedMimeInfo::UpdateMimeDatabase``
+    The update-mime-database executable
+
+The follow macro is available::
+
+  update_xdg_mimetypes(<path>)
+
+Updates the XDG mime database at install time (unless the ``$DESTDIR``
+environment variable is set, in which case it is up to package managers to
+perform this task).
+
+Since pre-1.0.0.
+#]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake)
 
-- 
cgit v1.2.1