summaryrefslogtreecommitdiffstats
path: root/Modules/CheckSymbolExists.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-04-12 13:25:46 (GMT)
committerBrad King <brad.king@kitware.com>2017-04-12 13:25:46 (GMT)
commitb416d3e696f5976ecc80f79e39715f35114e41fd (patch)
tree6d983c4b5d650472ed96da5028a7816f493c56cc /Modules/CheckSymbolExists.cmake
parentfddd559406558a2037733e5b760e9dd04e9edfd1 (diff)
downloadCMake-b416d3e696f5976ecc80f79e39715f35114e41fd.zip
CMake-b416d3e696f5976ecc80f79e39715f35114e41fd.tar.gz
CMake-b416d3e696f5976ecc80f79e39715f35114e41fd.tar.bz2
CheckSymbolExists: Convert docs to bracket comment syntax
Diffstat (limited to 'Modules/CheckSymbolExists.cmake')
-rw-r--r--Modules/CheckSymbolExists.cmake65
1 files changed, 33 insertions, 32 deletions
diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake
index 8fecc57..e9c4db3 100644
--- a/Modules/CheckSymbolExists.cmake
+++ b/Modules/CheckSymbolExists.cmake
@@ -1,38 +1,39 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
-#.rst:
-# CheckSymbolExists
-# -----------------
-#
-# Check if a symbol exists as a function, variable, or macro
-#
-# CHECK_SYMBOL_EXISTS(<symbol> <files> <variable>)
-#
-# Check that the <symbol> is available after including given header
-# <files> and store the result in a <variable>. Specify the list of
-# files in one argument as a semicolon-separated list.
-# <variable> 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++.
-#
-# 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
+#[=======================================================================[.rst:
+CheckSymbolExists
+-----------------
+
+Check if a symbol exists as a function, variable, or macro
+
+CHECK_SYMBOL_EXISTS(<symbol> <files> <variable>)
+
+Check that the <symbol> is available after including given header
+<files> and store the result in a <variable>. Specify the list of
+files in one argument as a semicolon-separated list.
+<variable> 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++.
+
+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
+#]=======================================================================]
macro(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
if(CMAKE_C_COMPILER_LOADED)