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'.

1 files changed, 15 insertions, 14 deletions

diff --git a/Modules/CheckFortranSourceCompiles.cmake b/Modules/CheckFortranSourceCompiles.cmake
index d2b0cca..977b7b4 100644
--- a/Modules/CheckFortranSourceCompiles.cmake
+++ b/Modules/CheckFortranSourceCompiles.cmake
@@ -9,23 +9,24 @@ Check if given Fortran source compiles and links into an executable.
 
 .. command:: check_fortran_source_compiles
 
-  ::
+  .. code-block:: cmake
 
-    check_fortran_source_compiles(code resultVar
-        [FAIL_REGEX regex1 [regex2...]]
-        [SRC_EXT ext]
+    check_fortran_source_compiles(<code> <resultVar>
+        [FAIL_REGEX <regex>...]
+        [SRC_EXT <extension>]
     )
 
-  Check that the source supplied in ``code`` can be compiled as a Fortran
+  Checks that the source supplied in ``<code>`` can be compiled as a Fortran
   source file and linked as an executable (so it must contain at least a
   ``PROGRAM`` entry point). The result will be stored in the internal cache
-  variable specified by ``resultVar``, with a boolean true value for success
-  and boolean false for failure. If ``FAIL_REGEX`` is provided, then failure is
-  determined by checking if anything in the output matches any of the specified
-  regular expressions.
+  variable ``<resultVar>``, with a boolean true value for success and boolean
+  false for failure.
+
+  If ``FAIL_REGEX`` is provided, then failure is determined by checking
+  if anything in the output matches any of the specified regular expressions.
 
   By default, the test source file will be given a ``.F`` file extension. The
-  ``SRC_EXT`` option can be used to override this with ``.ext`` instead.
+  ``SRC_EXT`` option can be used to override this with ``.<extension>`` instead.
 
   The underlying check is performed by the :command:`try_compile` command. The
   compile and link commands can be influenced by setting any of the following
@@ -40,7 +41,7 @@ Check if given Fortran source compiles and links into an executable.
   ``CMAKE_REQUIRED_DEFINITIONS``
     A :ref:`;-list <CMake Language Lists>` of compiler definitions of the form
     ``-DFOO`` or ``-DFOO=bar``. A definition for the name specified by
-    ``resultVar`` will also be added automatically.
+    ``<resultVar>`` will also be added automatically.
 
   ``CMAKE_REQUIRED_INCLUDES``
     A :ref:`;-list <CMake Language Lists>` of header search paths to pass to
@@ -59,10 +60,10 @@ Check if given Fortran source compiles and links into an executable.
     associated with the check will be suppressed.
 
   The check is only performed once, with the result cached in the variable
-  named by ``resultVar``. Every subsequent CMake run will re-use this cached
-  value rather than performing the check again, even if the ``code`` changes.
+  named by ``<resultVar>``. Every subsequent CMake run will re-use this cached
+  value rather than performing the check again, even if the ``<code>`` changes.
   In order to force the check to be re-evaluated, the variable named by
-  ``resultVar`` must be manually removed from the cache.
+  ``<resultVar>`` must be manually removed from the cache.
 
 #]=======================================================================]