summaryrefslogtreecommitdiff
path: root/Modules/CheckVariableExists.cmake
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2005-12-14 13:51:08 -0500
committerBill Hoffman <bill.hoffman@kitware.com>2005-12-14 13:51:08 -0500
commitb7fa820118d6989ca4d77dbfcc972c2e903bfe2a (patch)
treea5605c468a458597fff5f17485fad8cd85856e1b /Modules/CheckVariableExists.cmake
parent805d365d479a916acf2c5638809fb046fc28dc97 (diff)
downloadcmake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.gz
ENH: add documentation support for modules
Diffstat (limited to 'Modules/CheckVariableExists.cmake')
-rw-r--r--Modules/CheckVariableExists.cmake16
1 files changed, 7 insertions, 9 deletions
diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake
index ed1dfb306f..1cebdee3cc 100644
--- a/Modules/CheckVariableExists.cmake
+++ b/Modules/CheckVariableExists.cmake
@@ -1,14 +1,12 @@
-#
-# Check if the variable exists.
-# # CHECK_VARIABLE_EXISTS - macro which checks if the variable exists
-# VAR - the name of the variable
-# VARIABLE - variable to store the result
-#
+# - Check if the variable exists.
+# CHECK_VARIABLE_EXISTS(VAR VARIABLE)
+# - macro which checks if the variable exists
+# VAR - the name of the variable
+# VARIABLE - variable to store the result
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
# compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then
-# those libraries will be linked against the test program
-#
-# only for C variables
+# those libraries will be linked against the test program.
+# This macro is only for C variables.
#
MACRO(CHECK_VARIABLE_EXISTS VAR VARIABLE)
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")