summaryrefslogtreecommitdiff
path: root/Modules/FindJPEG.cmake
diff options
context:
space:
mode:
authorMateusz Loskot <mateusz@loskot.net>2018-04-17 21:46:50 +0200
committerMateusz Loskot <mateusz@loskot.net>2018-04-17 22:48:36 +0200
commit8d07408a62c03123c0c49b9946025930d1d61e16 (patch)
tree8e3b3a636b9e594fdc1cacbd11fd71efcb507519 /Modules/FindJPEG.cmake
parente70da3f0f3fe2f4373152953ba9822ce0f368cf5 (diff)
downloadcmake-8d07408a62c03123c0c49b9946025930d1d61e16.tar.gz
FindJPEG: Cleanup documentation formatting
Diffstat (limited to 'Modules/FindJPEG.cmake')
-rw-r--r--Modules/FindJPEG.cmake24
1 files changed, 15 insertions, 9 deletions
diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake
index a9e63968cf..04e4d207f3 100644
--- a/Modules/FindJPEG.cmake
+++ b/Modules/FindJPEG.cmake
@@ -5,21 +5,27 @@
# FindJPEG
# --------
#
-# Find JPEG
+# Find the JPEG library (libjpeg)
#
-# Find the native JPEG includes and library This module defines
+# Result variables
+# ^^^^^^^^^^^^^^^^
#
-# ::
+# This module will set the following variables in your project:
#
-# JPEG_INCLUDE_DIR, where to find jpeglib.h, etc.
-# JPEG_LIBRARIES, the libraries needed to use JPEG.
-# JPEG_FOUND, If false, do not try to use JPEG.
+# ``JPEG_FOUND``
+# If false, do not try to use JPEG.
+# ``JPEG_INCLUDE_DIR``
+# where to find jpeglib.h, etc.
+# ``JPEG_LIBRARIES``
+# the libraries needed to use JPEG.
#
-# also defined, but not for general use are
+# Cache variables
+# ^^^^^^^^^^^^^^^
#
-# ::
+# The following cache variables may also be set:
#
-# JPEG_LIBRARY, where to find the JPEG library.
+# ``JPEG_LIBRARY``
+# where to find the JPEG library.
find_path(JPEG_INCLUDE_DIR jpeglib.h)