aboutsummaryrefslogtreecommitdiff
path: root/find-modules/FindOpenEXR.cmake
diff options
context:
space:
mode:
authorAlex Merry <alex.merry@kde.org>2014-04-10 21:38:09 +0100
committerAlex Merry <alex.merry@kde.org>2014-04-11 21:12:58 +0100
commitc20d22c951e61a06701f6c2201add7c11915e7c5 (patch)
treea8f375967eaeeceffac6da5098700b4563bf2306 /find-modules/FindOpenEXR.cmake
parentddd33b850bb519174511a34eeda40af69a1f7144 (diff)
downloadextra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.gz
extra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.bz2
Add documentation generation using Sphinx
This is deliberately modelled very closely on CMake's documentation system. It's a hefty patch, because it involved changing all the documentation to be in reStructuredText format. I also cleaned up the copyright/license statements at the same time. Note that the find modules contain the full license, due to the fact that ecm_use_find_module() copies them out of the ECM distribution.
Diffstat (limited to 'find-modules/FindOpenEXR.cmake')
-rw-r--r--find-modules/FindOpenEXR.cmake36
1 files changed, 26 insertions, 10 deletions
diff --git a/find-modules/FindOpenEXR.cmake b/find-modules/FindOpenEXR.cmake
index 00a2364e..85afebdf 100644
--- a/find-modules/FindOpenEXR.cmake
+++ b/find-modules/FindOpenEXR.cmake
@@ -1,17 +1,32 @@
-# Try to find the OpenEXR libraries
+#.rst:
+# FindOpenEXR
+# -----------
#
-# This will define:
+# Try to find the OpenEXR libraries.
#
-# 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
-# OpenEXR::IlmImf - imported target to link against (instead of using the above variables)
+# 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.
-
-# Copyright (c) 2006, Alexander Neundorf, <neundorf@kde.org>
-# Copyright (c) 2013-2014, Alex Merry, <alex.merry@kdemail.net>
+#=============================================================================
+# Copyright 2013-2014 Alex Merry <alex.merry@kdemail.net>
+# Copyright 2006 Alexander Neundorf <neundorf@kde.org>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
@@ -35,6 +50,7 @@
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
if(${CMAKE_VERSION} VERSION_LESS 2.8.12)