From df606cbf2dec70572fb9c18af44f101419786305 Mon Sep 17 00:00:00 2001 From: Peter Kokot Date: Sat, 2 Aug 2025 03:23:04 +0200 Subject: [PATCH] FindGIF: Sync documentation - Added intro code block showing how to use this module. - Resorted variables and synced their descriptions. --- Modules/FindGIF.cmake | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/Modules/FindGIF.cmake b/Modules/FindGIF.cmake index 585b84612e..e3a751b7ed 100644 --- a/Modules/FindGIF.cmake +++ b/Modules/FindGIF.cmake @@ -5,7 +5,11 @@ FindGIF ------- -Finds the Graphics Interchange Format (GIF) library (``giflib``). +Finds the Graphics Interchange Format (GIF) library (``giflib``): + +.. code-block:: cmake + + find_package(GIF [] [...]) Imported Targets ^^^^^^^^^^^^^^^^ @@ -21,19 +25,22 @@ This module provides the following :ref:`Imported Targets`: Result Variables ^^^^^^^^^^^^^^^^ -This module sets the following variables: +This module defines the following variables: ``GIF_FOUND`` - Boolean indicating whether the GIF library was found. -``GIF_INCLUDE_DIRS`` - Include directories needed to use the GIF library. -``GIF_LIBRARIES`` - Libraries needed to link to the GIF library. + Boolean indicating whether (the requested version of) GIF library was found. + ``GIF_VERSION`` Version string of the GIF library found (for example, ``5.1.4``). For GIF library versions prior to 4.1.6, version string will be set only to ``3`` or ``4`` as these versions did not provide version information in their headers. +``GIF_INCLUDE_DIRS`` + Include directories needed to use the GIF library. + +``GIF_LIBRARIES`` + Libraries needed to link to the GIF library. + Cache Variables ^^^^^^^^^^^^^^^ @@ -41,6 +48,7 @@ The following cache variables may also be set: ``GIF_INCLUDE_DIR`` Directory containing the ``gif_lib.h`` and other GIF library headers. + ``GIF_LIBRARY`` Path to the GIF library.