diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/return.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
Diffstat (limited to 'doc_src/return.txt')
| -rw-r--r-- | doc_src/return.txt | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 9563cf39..a044e58a 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -1,12 +1,14 @@ \section return return - stop the current inner function \subsection return-synopsis Synopsis -<tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt> +\fish{syn} +function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end +\endfish \subsection return-description Description -\c return halts a currently running function. The exit status is set -to \c STATUS if it is given. +`return` halts a currently running function. The exit status is set +to `STATUS` if it is given. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> @@ -17,10 +19,10 @@ function. \subsection return-example Example The following code is an implementation of the false command as a fish function -<pre> +\fish function false - return 1 + return 1 end -</pre> +\endfish |