Merge topic 'doc-CheckSymbolExists-enum'

4995b26 Update CheckSymbolExists copyright year
840f9c0 Document CheckSymbolExists more clearly (#11685)
This commit is contained in:
Brad King 2011-01-19 14:02:38 -05:00 committed by CMake Topic Stage
commit ef27b9cd89
1 changed files with 13 additions and 6 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:
@ -14,7 +21,7 @@
# CMAKE_REQUIRED_LIBRARIES = list of libraries to link # CMAKE_REQUIRED_LIBRARIES = list of libraries to link
#============================================================================= #=============================================================================
# Copyright 2003-2009 Kitware, Inc. # Copyright 2003-2011 Kitware, Inc.
# #
# Distributed under the OSI-approved BSD License (the "License"); # Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details. # see accompanying file Copyright.txt for details.