From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 1 Aug 2014 03:37:32 +0100 Subject: 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. --- doc_src/return.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'doc_src/return.txt') 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 -function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end +\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 if statement or a switch @@ -17,10 +19,10 @@ function. \subsection return-example Example The following code is an implementation of the false command as a fish function -
+\fish
 function false
-	return 1
+    return 1
 end
-
+\endfish -- cgit v1.2.3