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'.
This commit is contained in:
Joachim Wuttke (l)
2018-10-09 21:55:10 +02:00
committed by Craig Scott
parent fc7ee1ca45
commit 93f3f65516
14 changed files with 126 additions and 114 deletions
+10 -10
View File
@@ -5,24 +5,24 @@
# CheckFortranFunctionExists
# --------------------------
#
# macro which checks if the Fortran function exists
# :command:`Macro <macro>` which checks if a Fortran function exists.
#
# CHECK_FORTRAN_FUNCTION_EXISTS(FUNCTION VARIABLE)
# .. code-block:: cmake
#
# ::
#
# FUNCTION - the name of the Fortran function
# VARIABLE - variable to store the result
# Will be created as an internal cache variable.
# CHECK_FORTRAN_FUNCTION_EXISTS(<function> <result>)
#
# where
#
# ``<function>``
# the name of the Fortran function
# ``<result>``
# 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_LIBRARIES = list of libraries to link
# ``CMAKE_REQUIRED_LIBRARIES``
# list of libraries to link
include_guard(GLOBAL)