mirror of
https://github.com/reactos/CMake.git
synced 2024-11-24 20:19:53 +00:00
c2efb3efcd
Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
20 lines
731 B
ReStructuredText
20 lines
731 B
ReStructuredText
return
|
|
------
|
|
|
|
Return from a file, directory or function.
|
|
|
|
.. code-block:: cmake
|
|
|
|
return()
|
|
|
|
Returns from a file, directory or function. When this command is
|
|
encountered in an included file (via :command:`include` or
|
|
:command:`find_package`), it causes processing of the current file to stop
|
|
and control is returned to the including file. If it is encountered in a
|
|
file which is not included by another file, e.g. a ``CMakeLists.txt``,
|
|
control is returned to the parent directory if there is one. If return is
|
|
called in a function, control is returned to the caller of the function.
|
|
|
|
Note that a :command:`macro <macro>`, unlike a :command:`function <function>`,
|
|
is expanded in place and therefore cannot handle ``return()``.
|