aboutsummaryrefslogtreecommitdiff
path: root/find-modules/FindSasl2.cmake
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2021-04-17 11:02:00 +0200
committerFriedrich W. H. Kossebau <kossebau@kde.org>2021-04-23 17:49:14 +0000
commit5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch)
tree3caca041d3526c8427ec3065642b41a52ad8578c /find-modules/FindSasl2.cmake
parent38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff)
downloadextra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz
extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2
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
Diffstat (limited to 'find-modules/FindSasl2.cmake')
-rw-r--r--find-modules/FindSasl2.cmake66
1 files changed, 32 insertions, 34 deletions
diff --git a/find-modules/FindSasl2.cmake b/find-modules/FindSasl2.cmake
index b89b0884..7693b0e9 100644
--- a/find-modules/FindSasl2.cmake
+++ b/find-modules/FindSasl2.cmake
@@ -1,40 +1,38 @@
-#.rst:
-# FindSasl2
-# ---------
-#
-# Try to find the SASL2 library.
-#
-# This will define the following variables:
-#
-# ``Sasl2_FOUND``
-# System has SASL2.
-#
-# ``Sasl2_VERSION``
-# The version of SASL2.
-#
-# ``Sasl2_INCLUDE_DIRS``
-# This should be passed to target_include_directories() if
-# the target is not used for linking.
-#
-# ``Sasl2_LIBRARIES``
-# The SASL2 library.
-# This can be passed to target_link_libraries() instead of
-# the ``Sasl2::Sasl2`` target
-#
-# If ``Sasl2_FOUND`` is TRUE, the following imported target
-# will be available:
-#
-# ``Sasl2::Sasl2``
-# The SASL2 library
-#
-# Since 5.41.0.
-#
-#=============================================================================
# SPDX-FileCopyrightText: 2006, 2007 Laurent Montel <montel@kde.org>
#
-#
# SPDX-License-Identifier: BSD-3-Clause
-#=============================================================================
+
+#[=======================================================================[.rst:
+FindSasl2
+---------
+
+Try to find the SASL2 library.
+
+This will define the following variables:
+
+``Sasl2_FOUND``
+ System has SASL2.
+
+``Sasl2_VERSION``
+ The version of SASL2.
+
+``Sasl2_INCLUDE_DIRS``
+ This should be passed to target_include_directories() if
+ the target is not used for linking.
+
+``Sasl2_LIBRARIES``
+ The SASL2 library.
+ This can be passed to target_link_libraries() instead of
+ the ``Sasl2::Sasl2`` target
+
+If ``Sasl2_FOUND`` is TRUE, the following imported target
+will be available:
+
+``Sasl2::Sasl2``
+ The SASL2 library
+
+Since 5.41.0.
+#]=======================================================================]
# NOTE: libsasl2.pc doesn't export the include dir.
find_package(PkgConfig QUIET)