diff options
author | Joachim Wuttke (l) <j.wuttke@fz-juelich.de> | 2018-10-09 19:55:10 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2018-10-18 20:27:31 (GMT) |
commit | 93f3f65516c65d79fe7bea54e883f1d767a99b6b (patch) | |
tree | 6a69af9d68f1fc06e312d4bc77740890af68e872 /Modules/CheckFunctionExists.cmake | |
parent | fc7ee1ca459c3b231aa1fb64aeeaee590c019513 (diff) | |
download | CMake-93f3f65516c65d79fe7bea54e883f1d767a99b6b.zip CMake-93f3f65516c65d79fe7bea54e883f1d767a99b6b.tar.gz CMake-93f3f65516c65d79fe7bea54e883f1d767a99b6b.tar.bz2 |
Help: Revise docs of modules AddFileDependencies..CheckFunctionExists
* Replace '::' by '.. code-block:: cmake' wherever it makes sense.
* Convert to definition list where appropriate.
* Prefer '<placeholder>' over 'placeholder'.
Diffstat (limited to 'Modules/CheckFunctionExists.cmake')
-rw-r--r-- | Modules/CheckFunctionExists.cmake | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake index d00aa8a..45f7a6b 100644 --- a/Modules/CheckFunctionExists.cmake +++ b/Modules/CheckFunctionExists.cmake @@ -5,24 +5,29 @@ # CheckFunctionExists # ------------------- # -# Check if a C function can be linked:: +# Check if a C function can be linked +# +# .. code-block:: cmake # # check_function_exists(<function> <variable>) # -# Check that the ``<function>`` is provided by libraries on the system and store -# the result in a ``<variable>``. ``<variable>`` will be created as an internal +# Checks that the ``<function>`` is provided by libraries on the system and store +# the result in a ``<variable>``, which 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_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 # # .. note:: # |