From 91233d563b196fe0ee6c4d1dec0b20990723946b Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 12 Apr 2017 09:30:39 -0400 Subject: CheckSymbolExists: Format documentation --- Modules/CheckSymbolExists.cmake | 44 ++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index e9c4db3..d92f4b2 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -5,34 +5,42 @@ CheckSymbolExists ----------------- -Check if a symbol exists as a function, variable, or macro +Provides a macro to check if a symbol exists as a function, variable, +or macro in ``C``. -CHECK_SYMBOL_EXISTS( ) +.. command:: check_symbol_exists -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. - will be created as an internal cache variable. + :: + + check_symbol_exists( ) + + 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. + ```` will be created as an internal cache variable. 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). If -the check needs to be done in C++, consider using -CHECK_CXX_SYMBOL_EXISTS(), which does the same as -CHECK_SYMBOL_EXISTS(), but in C++. +linking. +If the symbol is a type or enum value it will not be recognized +(consider using :module:`CheckTypeSize` or :module:`CheckCSourceCompiles`). +If the check needs to be done in C++, consider using +:module:`CheckCXXSymbolExists` instead. The following variables may be set before calling this macro to modify the way the check is run: -:: - - CMAKE_REQUIRED_FLAGS = string of compile command line flags - CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) - CMAKE_REQUIRED_INCLUDES = list of include directories - CMAKE_REQUIRED_LIBRARIES = list of libraries to link - CMAKE_REQUIRED_QUIET = execute quietly without messages +``CMAKE_REQUIRED_FLAGS`` + string of compile command line flags +``CMAKE_REQUIRED_DEFINITIONS`` + list of macros to define (-DFOO=bar) +``CMAKE_REQUIRED_INCLUDES`` + list of include directories +``CMAKE_REQUIRED_LIBRARIES`` + list of libraries to link +``CMAKE_REQUIRED_QUIET`` + execute quietly without messages #]=======================================================================] macro(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE) -- cgit v0.12