mirrors/cmake
2
0 Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-10-10 23:43:58 +03:00
Code Activity

FindJPEG: Sync documentation

Browse Source 
- Added intro code block showing how to use this module.
- Resorted result variables.
- Renamed "Obsolete Variables" to "Deprecated Variables" to make it more
  clear, what to use.
This commit is contained in:
Peter Kokot committed 2025-08-02 04:31:59 +02:00
1 parent a4ef872a24
commit 2d59d24075
1 file changed
+17 -13
Download Patch File Download Diff File Expand all files Collapse all files
Modules/FindJPEG.cmake
+17 -13
View File
@@ -5,7 +5,11 @@
FindJPEG
--------
Finds the Joint Photographic Experts Group (JPEG) library (``libjpeg``).
Finds the Joint Photographic Experts Group (JPEG) library (``libjpeg``):
.. code-block:: cmake
find_package(JPEG [<version>] [...])
.. versionchanged:: 3.12
Debug and Release JPEG library variants are now found separately.
@@ -24,10 +28,15 @@ This module provides the following :ref:`Imported Targets`:
Result Variables
^^^^^^^^^^^^^^^^
This module sets the following variables:
This module defines the following variables:
``JPEG_FOUND``
Boolean indicating whether the JPEG is found.
Boolean indicating whether (the requested version of) JPEG library is found.
``JPEG_VERSION``
.. versionadded:: 3.12
The version of JPEG library found.
``JPEG_INCLUDE_DIRS``
Include directories containing headers needed to use JPEG.
@@ -35,18 +44,13 @@ This module sets the following variables:
``JPEG_LIBRARIES``
Libraries needed to link to JPEG.
``JPEG_VERSION``
.. versionadded:: 3.12
The version of the JPEG library found.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``JPEG_INCLUDE_DIR``
Directory containing the ``jpeglib.h`` and related header files.
Directory containing the ``<jpeglib.h>`` and related header files.
``JPEG_LIBRARY_RELEASE``
.. versionadded:: 3.12
@@ -58,13 +62,13 @@ The following cache variables may also be set:
Path to the debug variant of the JPEG library.
Obsolete Variables
^^^^^^^^^^^^^^^^^^
Deprecated Variables
^^^^^^^^^^^^^^^^^^^^
The following legacy variables are provided for backward compatibility:
The following variables are provided for backward compatibility:
``JPEG_LIBRARY``
.. versionchanged:: 3.12
.. deprecated:: 3.12
This variable has been superseded by the ``JPEG_LIBRARY_RELEASE`` and
``JPEG_LIBRARY_DEBUG`` variables.