diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2018-10-22 10:31:08 -0400 |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-10-22 11:09:34 -0400 |
| commit | df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56 (patch) | |
| tree | 4617dc2407a2e8e9c2bfdf77f09bdd396a9823e0 /Modules/CheckLibraryExists.cmake | |
| parent | 7115aa6c2249ec368fe0dfbd257a22eb0e04042d (diff) | |
| download | cmake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.gz | |
Help: Convert remaining modules to block-style comments
Diffstat (limited to 'Modules/CheckLibraryExists.cmake')
| -rw-r--r-- | Modules/CheckLibraryExists.cmake | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake index 487cc592a3..428a6b0ad0 100644 --- a/Modules/CheckLibraryExists.cmake +++ b/Modules/CheckLibraryExists.cmake @@ -1,33 +1,34 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# CheckLibraryExists -# ------------------ -# -# Check if the function exists. -# -# CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE) -# -# :: -# -# LIBRARY - the name of the library you are looking for -# FUNCTION - the name of the function -# LOCATION - location where the library should be found -# VARIABLE - variable to store the result -# Will be created as an internal cache variable. -# -# -# -# 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_LIBRARIES = list of libraries to link -# CMAKE_REQUIRED_QUIET = execute quietly without messages +#[=======================================================================[.rst: +CheckLibraryExists +------------------ + +Check if the function exists. + +CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE) + +:: + + LIBRARY - the name of the library you are looking for + FUNCTION - the name of the function + LOCATION - location where the library should be found + VARIABLE - variable to store the result + Will be created as an internal cache variable. + + + +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_LIBRARIES = list of libraries to link + CMAKE_REQUIRED_QUIET = execute quietly without messages +#]=======================================================================] include_guard(GLOBAL) |