h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-25 20:41:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse Source 
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.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc_src/return.txt
View File

@@ -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