summaryrefslogtreecommitdiff
path: root/Modules/CheckSymbolExists.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/CheckSymbolExists.cmake
parent805d365d479a916acf2c5638809fb046fc28dc97 (diff)
downloadcmake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.gz
ENH: add documentation support for modules
Diffstat (limited to 'Modules/CheckSymbolExists.cmake')
-rw-r--r--Modules/CheckSymbolExists.cmake15
1 files changed, 7 insertions, 8 deletions
diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake
index cc1ca75f46..6d965fb32d 100644
--- a/Modules/CheckSymbolExists.cmake
+++ b/Modules/CheckSymbolExists.cmake
@@ -1,11 +1,10 @@
-#
-# Check if the symbol exists in include files
-#
-# CHECK_SYMBOL_EXISTS - macro which checks the symbol exists in include files.
-# SYMBOL - symbol
-# FILES - include files to check
-# VARIABLE - variable to return result
-#
+# - Check if the symbol exists in include files
+# CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE)
+# - macro which checks the symbol exists in include files.
+# SYMBOL - symbol
+# FILES - include files to check
+# VARIABLE - variable to return 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