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/ECMQMLModules.cmake | 57 ++++++++++++++++++++++-----------------------
 1 file changed, 28 insertions(+), 29 deletions(-)

(limited to 'modules/ECMQMLModules.cmake')

diff --git a/modules/ECMQMLModules.cmake b/modules/ECMQMLModules.cmake
index 705aac07..58dbde82 100644
--- a/modules/ECMQMLModules.cmake
+++ b/modules/ECMQMLModules.cmake
@@ -1,35 +1,34 @@
-#.rst:
-# ECMQMLModules
-# -------------
-#
-# Find QML import modules through a find_qmlmodule() call.
-# It uses the qmlplugindump application to find the plugins and sets them up as
-# runtime dependencies.
-#
-# This is useful so that when we configure a project we are noified when some
-# QML imports are not present in the system, thus having the application compilable
-# but fail at runtime.
-#
-# ::
-#
-#   ecm_find_qmlmodule(<module_name> <version>...)
-#
-# Any further arguments passed will be forwarded into a find_package() call. See
-# find_package() documentation for more information.
-#
-# Usage example:
-#
-# .. code-block:: cmake
-#
-#   ecm_find_qmlmodule(org.kde.kirigami 2.1)
-#
-# Since 5.38.0.
-#
-#=============================================================================
 # SPDX-FileCopyrightText: 2015 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+ECMQMLModules
+-------------
+
+Find QML import modules through a find_qmlmodule() call.
+It uses the qmlplugindump application to find the plugins and sets them up as
+runtime dependencies.
+
+This is useful so that when we configure a project we are noified when some
+QML imports are not present in the system, thus having the application compilable
+but fail at runtime.
+
+::
+
+  ecm_find_qmlmodule(<module_name> <version>...)
+
+Any further arguments passed will be forwarded into a find_package() call. See
+find_package() documentation for more information.
+
+Usage example:
+
+.. code-block:: cmake
+
+  ecm_find_qmlmodule(org.kde.kirigami 2.1)
+
+Since 5.38.0.
+#]=======================================================================]
 
 set(MODULES_DIR ${CMAKE_CURRENT_LIST_DIR})
 
-- 
cgit v1.2.1