aboutsummaryrefslogtreecommitdiff
path: root/find-modules/Findepoxy.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/Findepoxy.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/Findepoxy.cmake')
-rw-r--r--find-modules/Findepoxy.cmake67
1 files changed, 34 insertions, 33 deletions
diff --git a/find-modules/Findepoxy.cmake b/find-modules/Findepoxy.cmake
index 548be5bc..3882b9ba 100644
--- a/find-modules/Findepoxy.cmake
+++ b/find-modules/Findepoxy.cmake
@@ -1,41 +1,42 @@
-#.rst:
-# Findepoxy
-# ---------
-#
-# Try to find libepoxy on a Unix system.
-#
-# This will define the following variables:
-#
-# ``epoxy_FOUND``
-# True if (the requested version of) libepoxy is available
-# ``epoxy_VERSION``
-# The version of libepoxy
-# ``epoxy_LIBRARIES``
-# This should be passed to target_link_libraries() if the target is not
-# used for linking
-# ``epoxy_INCLUDE_DIRS``
-# This should be passed to target_include_directories() if the target is not
-# used for linking
-# ``epoxy_DEFINITIONS``
-# This should be passed to target_compile_options() if the target is not
-# used for linking
-# ``epoxy_HAS_GLX``
-# True if GLX support is available
-#
-# If ``epoxy_FOUND`` is TRUE, it will also define the following imported target:
-#
-# ``epoxy::epoxy``
-# The epoxy 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.
-
# SPDX-FileCopyrightText: 2014 Fredrik Höglund <fredrik@kde.org>
# SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
#
# SPDX-License-Identifier: BSD-3-Clause
+#[=======================================================================[.rst:
+Findepoxy
+---------
+
+Try to find libepoxy on a Unix system.
+
+This will define the following variables:
+
+``epoxy_FOUND``
+ True if (the requested version of) libepoxy is available
+``epoxy_VERSION``
+ The version of libepoxy
+``epoxy_LIBRARIES``
+ This should be passed to target_link_libraries() if the target is not
+ used for linking
+``epoxy_INCLUDE_DIRS``
+ This should be passed to target_include_directories() if the target is not
+ used for linking
+``epoxy_DEFINITIONS``
+ This should be passed to target_compile_options() if the target is not
+ used for linking
+``epoxy_HAS_GLX``
+ True if GLX support is available
+
+If ``epoxy_FOUND`` is TRUE, it will also define the following imported target:
+
+``epoxy::epoxy``
+ The epoxy 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.
+#]=======================================================================]
+
find_package(PkgConfig)
pkg_check_modules(PKG_epoxy QUIET epoxy)