summaryrefslogtreecommitdiffstats
path: root/Modules/FindSDL_ttf.cmake
diff options
context:
space:
mode:
authorBenjamin Eikel <cmake@eikel.org>2012-09-04 14:12:13 (GMT)
committerBrad King <brad.king@kitware.com>2012-09-25 17:52:35 (GMT)
commit22154c7fc23e32c97952e368f7437999576ea082 (patch)
tree5dd2515c471f34429db8e80d3a1bdb4c47b0af02 /Modules/FindSDL_ttf.cmake
parent4541c078645c367b36949b629ea33c17316cedeb (diff)
downloadCMake-22154c7fc23e32c97952e368f7437999576ea082.zip
CMake-22154c7fc23e32c97952e368f7437999576ea082.tar.gz
CMake-22154c7fc23e32c97952e368f7437999576ea082.tar.bz2
FindSDL: Update documentation
Diffstat (limited to 'Modules/FindSDL_ttf.cmake')
-rw-r--r--Modules/FindSDL_ttf.cmake16
1 files changed, 11 insertions, 5 deletions
diff --git a/Modules/FindSDL_ttf.cmake b/Modules/FindSDL_ttf.cmake
index 7ce775b..3a7027d 100644
--- a/Modules/FindSDL_ttf.cmake
+++ b/Modules/FindSDL_ttf.cmake
@@ -1,8 +1,14 @@
-# Locate SDL_ttf library
-# This module defines
-# SDLTTF_LIBRARY, the name of the library to link against
-# SDLTTF_FOUND, if false, do not try to link to SDL
-# SDLTTF_INCLUDE_DIR, where to find SDL/SDL.h
+# - Locate SDL_ttf library
+# This module defines:
+# SDL_TTF_LIBRARIES, the name of the library to link against
+# SDL_TTF_INCLUDE_DIRS, where to find the headers
+# SDL_TTF_FOUND, if false, do not try to link against
+# SDL_TTF_VERSION_STRING - human-readable string containing the version of SDL_ttf
+#
+# For backward compatiblity the following variables are also set:
+# SDLTTF_LIBRARY (same value as SDL_TTF_LIBRARIES)
+# SDLTTF_INCLUDE_DIR (same value as SDL_TTF_INCLUDE_DIRS)
+# SDLTTF_FOUND (same value as SDL_TTF_FOUND)
#
# $SDLDIR is an environment variable that would
# correspond to the ./configure --prefix=$SDLDIR