summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Eikel <cmake@eikel.org>2012-09-04 14:07:10 (GMT)
committerBrad King <brad.king@kitware.com>2012-09-25 17:52:25 (GMT)
commit9f5dbf4497c433217da2eaee89647584d9cbad67 (patch)
tree68135580956a2c5502b60764cd8b1537a4d0ffd6
parentd83f80d1744390a18780a178463724421fafc04a (diff)
downloadCMake-9f5dbf4497c433217da2eaee89647584d9cbad67.zip
CMake-9f5dbf4497c433217da2eaee89647584d9cbad67.tar.gz
CMake-9f5dbf4497c433217da2eaee89647584d9cbad67.tar.bz2
FindSDL: Update documentation
-rw-r--r--Modules/FindSDL_mixer.cmake16
1 files changed, 11 insertions, 5 deletions
diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake
index 3139ff2..1d5839d 100644
--- a/Modules/FindSDL_mixer.cmake
+++ b/Modules/FindSDL_mixer.cmake
@@ -1,8 +1,14 @@
-# Locate SDL_mixer library
-# This module defines
-# SDLMIXER_LIBRARY, the name of the library to link against
-# SDLMIXER_FOUND, if false, do not try to link to SDL
-# SDLMIXER_INCLUDE_DIR, where to find SDL/SDL.h
+# - Locate SDL_mixer library
+# This module defines:
+# SDL_MIXER_LIBRARIES, the name of the library to link against
+# SDL_MIXER_INCLUDE_DIRS, where to find the headers
+# SDL_MIXER_FOUND, if false, do not try to link against
+# SDL_MIXER_VERSION_STRING - human-readable string containing the version of SDL_mixer
+#
+# For backward compatiblity the following variables are also set:
+# SDLMIXER_LIBRARY (same value as SDL_MIXER_LIBRARIES)
+# SDLMIXER_INCLUDE_DIR (same value as SDL_MIXER_INCLUDE_DIRS)
+# SDLMIXER_FOUND (same value as SDL_MIXER_FOUND)
#
# $SDLDIR is an environment variable that would
# correspond to the ./configure --prefix=$SDLDIR