mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-22 06:09:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve formatting of command documentation

Browse Source 
Use inline reStructuredText markup and add cross-references in more
places.
This commit is contained in:
Michael Scott
2015-06-04 22:51:22 +01:00
committed by Brad King
parent d17aa60659
commit c3f40f4fd9
59 changed files with 352 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/return.rst
+7 -7
View File
@@ -8,11 +8,11 @@ Return from a file, directory or function.
return()
Returns from a file, directory or function. When this command is
encountered in an included file (via include() or 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 macro is not a function and does not handle return like a
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 macro is not a function and does not handle return like a
function does.