From 840f9c055cba5f587e42b9118d0b9924d396275e Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 12 Jan 2011 08:58:19 -0500 Subject: [PATCH] Document CheckSymbolExists more clearly (#11685) The check works for macros, functions, and variables, but not for types or enumeration values. Clearly describe the behavior of the check with respect to each symbol type. --- Modules/CheckSymbolExists.cmake | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index 40910f25c..2237f352c 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -1,9 +1,16 @@ -# - Check if the symbol exists in include files -# CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE) +# - Check if a symbol exists as a function, variable, or macro +# CHECK_SYMBOL_EXISTS( ) # -# SYMBOL - symbol -# FILES - include files to check -# VARIABLE - variable to return result +# Check that the is available after including given header +# and store the result in a . Specify the list +# of files in one argument as a semicolon-separated list. +# +# If the header files define the symbol as a macro it is considered +# available and assumed to work. If the header files declare the +# symbol as a function or variable then the symbol must also be +# available for linking. If the symbol is a type or enum value +# it will not be recognized (consider using CheckTypeSize or +# CheckCSourceCompiles). # # The following variables may be set before calling this macro to # modify the way the check is run: