summaryrefslogtreecommitdiffstats
path: root/Help/command/macro.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/macro.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/macro.rst')
-rw-r--r--Help/command/macro.rst30
1 files changed, 15 insertions, 15 deletions
diff --git a/Help/command/macro.rst b/Help/command/macro.rst
index 258dc50..33249c9 100644
--- a/Help/command/macro.rst
+++ b/Help/command/macro.rst
@@ -1,9 +1,7 @@
macro
-----
-Start recording a macro for later invocation as a command.
-
-::
+Start recording a macro for later invocation as a command::
macro(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
@@ -11,22 +9,24 @@ Start recording a macro for later invocation as a command.
...
endmacro(<name>)
-Define a macro named <name> that takes arguments named arg1 arg2 arg3
-(...). Commands listed after macro, but before the matching endmacro,
-are not invoked until the macro is invoked. When it is invoked, the
-commands recorded in the macro 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 values ``${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 macros with optional arguments.
+Define a macro named ``<name>`` that takes arguments named ``arg1``,
+``arg2``, ``arg3``, (...).
+Commands listed after macro, but before the matching
+:command:`endmacro()`, are not invoked until the macro is invoked.
+When it is invoked, the commands recorded in the macro 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
+values ``${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 macros with optional arguments.
Additionally ``${ARGV}`` holds the list of all arguments given to the
macro and ``${ARGN}`` holds the list of arguments past the last expected
argument.
-See the cmake_policy() command documentation for the behavior of
-policies inside macros.
+See the :command:`cmake_policy()` command documentation for the behavior
+of policies inside macros.
Macro Argument Caveats
^^^^^^^^^^^^^^^^^^^^^^