diff options
| author | Joachim Wuttke (l) <j.wuttke@fz-juelich.de> | 2018-10-09 21:55:10 +0200 |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-10-19 07:27:31 +1100 |
| commit | 93f3f65516c65d79fe7bea54e883f1d767a99b6b (patch) | |
| tree | 6a69af9d68f1fc06e312d4bc77740890af68e872 /Modules/CheckFortranFunctionExists.cmake | |
| parent | fc7ee1ca459c3b231aa1fb64aeeaee590c019513 (diff) | |
| download | cmake-93f3f65516c65d79fe7bea54e883f1d767a99b6b.tar.gz | |
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/CheckFortranFunctionExists.cmake')
| -rw-r--r-- | Modules/CheckFortranFunctionExists.cmake | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Modules/CheckFortranFunctionExists.cmake b/Modules/CheckFortranFunctionExists.cmake index f3ced93d7c..fbfa061a24 100644 --- a/Modules/CheckFortranFunctionExists.cmake +++ b/Modules/CheckFortranFunctionExists.cmake @@ -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) |