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.
This commit is contained in:
Brad King 2011-01-12 08:58:19 -05:00
parent 90e9b65f10
commit 840f9c055c
1 changed files with 12 additions and 5 deletions

View File

@ -1,9 +1,16 @@
# - Check if the symbol exists in include files # - Check if a symbol exists as a function, variable, or macro
# CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE) # CHECK_SYMBOL_EXISTS(<symbol> <files> <variable>)
# #
# SYMBOL - symbol # Check that the <symbol> is available after including given header
# FILES - include files to check # <files> and store the result in a <variable>. Specify the list
# VARIABLE - variable to return result # 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 # The following variables may be set before calling this macro to
# modify the way the check is run: # modify the way the check is run: