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

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

diff --git a/find-modules/FindOpenEXR.cmake b/find-modules/FindOpenEXR.cmake
index 6245b42c..5b14c5c3 100644
--- a/find-modules/FindOpenEXR.cmake
+++ b/find-modules/FindOpenEXR.cmake
@@ -1,37 +1,36 @@
-#.rst:
-# FindOpenEXR
-# -----------
-#
-# Try to find the OpenEXR libraries.
-#
-# This will define the following variables:
-#
-# ``OpenEXR_FOUND``
-#     True if OpenEXR is available
-# ``OpenEXR_LIBRARIES``
-#     Link to these to use OpenEXR
-# ``OpenEXR_INCLUDE_DIRS``
-#     Include directory for OpenEXR
-# ``OpenEXR_DEFINITIONS``
-#     Compiler flags required to link against OpenEXR
-#
-# and the following imported targets:
-#
-# ``OpenEXR::IlmImf``
-#     The OpenEXR core library
-#
-# In general we recommend using the imported target, as it is easier to use.
-# Bear in mind, however, that if the target is in the link interface of an
-# exported library, it must be made available by the package config file.
-#
-# Since pre-1.0.0.
-
-#=============================================================================
 # SPDX-FileCopyrightText: 2013-2014 Alex Merry <alex.merry@kdemail.net>
 # SPDX-FileCopyrightText: 2006 Alexander Neundorf <neundorf@kde.org>
 #
 # SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindOpenEXR
+-----------
+
+Try to find the OpenEXR libraries.
+
+This will define the following variables:
+
+``OpenEXR_FOUND``
+    True if OpenEXR is available
+``OpenEXR_LIBRARIES``
+    Link to these to use OpenEXR
+``OpenEXR_INCLUDE_DIRS``
+    Include directory for OpenEXR
+``OpenEXR_DEFINITIONS``
+    Compiler flags required to link against OpenEXR
+
+and the following imported targets:
+
+``OpenEXR::IlmImf``
+    The OpenEXR core library
+
+In general we recommend using the imported target, as it is easier to use.
+Bear in mind, however, that if the target is in the link interface of an
+exported library, it must be made available by the package config file.
+
+Since pre-1.0.0.
+#]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake)
 
-- 
cgit v1.2.1