summaryrefslogtreecommitdiffstats
path: root/Modules/FindGLUT.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-12-17 17:49:45 (GMT)
committerBrad King <brad.king@kitware.com>2021-12-20 14:49:55 (GMT)
commit641b3f41016809a4160c919c6fb47481e33563ed (patch)
tree978279b01f768a63146599e06bc19335ea27b982 /Modules/FindGLUT.cmake
parent924b2999a1c2cf8aa8621904f8db9e488bbcf2c8 (diff)
downloadCMake-641b3f41016809a4160c919c6fb47481e33563ed.zip
CMake-641b3f41016809a4160c919c6fb47481e33563ed.tar.gz
CMake-641b3f41016809a4160c919c6fb47481e33563ed.tar.bz2
FindGLUT: Modernize documentation layout
Diffstat (limited to 'Modules/FindGLUT.cmake')
-rw-r--r--Modules/FindGLUT.cmake32
1 files changed, 20 insertions, 12 deletions
diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake
index 17d2f3d..fe1fa0f 100644
--- a/Modules/FindGLUT.cmake
+++ b/Modules/FindGLUT.cmake
@@ -20,24 +20,32 @@ This module defines the :prop_tgt:`IMPORTED` targets:
Result Variables
^^^^^^^^^^^^^^^^
-This module sets the following variables:
+This module defines the following variables:
-::
+``GLUT_FOUND``
+ True if ``glut`` was found.
- GLUT_INCLUDE_DIR, where to find GL/glut.h, etc.
- GLUT_LIBRARIES, the libraries to link against
- GLUT_FOUND, If false, do not try to use GLUT.
+``GLUT_INCLUDE_DIR``
+ Where to find GL/glut.h, etc.
-Also defined, but not for general use are:
+``GLUT_LIBRARIES``
+ List of libraries for using ``glut``.
-::
+Cache Variables
+^^^^^^^^^^^^^^^
- GLUT_glut_LIBRARY = the full path to the glut library.
- GLUT_Xmu_LIBRARY = the full path to the Xmu library.
- GLUT_Xi_LIBRARY = the full path to the Xi Library.
+This module may set the following variables depending on platform.
+These variables may optionally be set to help this module find the
+correct files, but clients should not use these as results:
-.. versionadded:: 3.13
- Debug and Release variants are found separately.
+``GLUT_glut_LIBRARY``
+ The full path to the glut library.
+
+``GLUT_Xmu_LIBRARY``
+ The full path to the Xmu library.
+
+``GLUT_Xi_LIBRARY``
+ The full path to the Xi Library.
#]=======================================================================]
include(${CMAKE_CURRENT_LIST_DIR}/SelectLibraryConfigurations.cmake)