summaryrefslogtreecommitdiffstats
path: root/Help/command/function.rst
diff options
context:
space:
mode:
authorDaniele E. Domenichelli <daniele.domenichelli@iit.it>2015-02-26 16:16:42 (GMT)
committerDaniele E. Domenichelli <daniele.domenichelli@iit.it>2015-02-26 16:19:52 (GMT)
commite3363bfbec592393780f9d769bd32334bcfd5953 (patch)
treeb8e7b9d246b9256b2147b743f929def8fe74d172 /Help/command/function.rst
parent1c3799b151b6ff79472281cd35ece3e067bc526b (diff)
downloadCMake-e3363bfbec592393780f9d769bd32334bcfd5953.zip
CMake-e3363bfbec592393780f9d769bd32334bcfd5953.tar.gz
CMake-e3363bfbec592393780f9d769bd32334bcfd5953.tar.bz2
Help: Refine the .rst formatting of macro and function documentation
Diffstat (limited to 'Help/command/function.rst')
-rw-r--r--Help/command/function.rst39
1 files changed, 20 insertions, 19 deletions
diff --git a/Help/command/function.rst b/Help/command/function.rst
index b18e03c..5bbffbf 100644
--- a/Help/command/function.rst
+++ b/Help/command/function.rst
@@ -1,9 +1,7 @@
function
--------
-Start recording a function for later invocation as a command.
-
-::
+Start recording a function for later invocation as a command::
function(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
@@ -11,21 +9,24 @@ Start recording a function for later invocation as a command.
...
endfunction(<name>)
-Define a function named <name> that takes arguments named arg1 arg2
-arg3 (...). Commands listed after function, but before the matching
-endfunction, are not invoked until the function is invoked. When it
-is invoked, the commands recorded in the function are first modified
-by replacing formal parameters (${arg1}) with the arguments passed,
-and then invoked as normal commands. In addition to referencing the
-formal parameters you can reference the variable ARGC which will be
-set to the number of arguments passed into the function as well as
-ARGV0 ARGV1 ARGV2 ... which will have the actual values of the
-arguments passed in. This facilitates creating functions with
-optional arguments. Additionally ARGV holds the list of all arguments
-given to the function and ARGN holds the list of arguments past the
-last expected argument.
+Define a function named ``<name>`` that takes arguments named ``arg1``,
+``arg2``, ``arg3``, (...).
+Commands listed after function, but before the matching
+:command:`endfunction()`, are not invoked until the function is invoked.
+When it is invoked, the commands recorded in the function are first
+modified by replacing formal parameters (``${arg1}``) with the arguments
+passed, and then invoked as normal commands.
+In addition to referencing the formal parameters you can reference the
+``ARGC`` variable which will be set to the number of arguments passed
+into the function as well as ``ARGV0``, ``ARGV1``, ``ARGV2``, ... which
+will have the actual values of the arguments passed in.
+This facilitates creating functions with optional arguments.
+Additionally ``ARGV`` holds the list of all arguments given to the
+function and ``ARGN`` holds the list of arguments past the last expected
+argument.
-A function opens a new scope: see set(var PARENT_SCOPE) for details.
+A function opens a new scope: see :command:`set(var PARENT_SCOPE)` for
+details.
-See the cmake_policy() command documentation for the behavior of
-policies inside functions.
+See the :command:`cmake_policy()` command documentation for the behavior
+of policies inside functions.