From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001
From: Mark Griffiths <mark@thebespokepixel.com>
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/begin.txt | 47 ++++++++++++++++++++++++-----------------------
 1 file changed, 24 insertions(+), 23 deletions(-)

(limited to 'doc_src/begin.txt')

diff --git a/doc_src/begin.txt b/doc_src/begin.txt
index fafe9849..aee50f5c 100644
--- a/doc_src/begin.txt
+++ b/doc_src/begin.txt
@@ -1,22 +1,23 @@
 \section begin begin - start a new block of code
 
 \subsection begin-synopsis Synopsis
- <tt>begin; [COMMANDS...;] end</tt>
+\fish{syn}
+begin; [COMMANDS...;] end
+\endfish
 
 \subsection begin-description Description
 
-\c begin is used to create a new block of code.
+`begin` is used to create a new block of code.
 
-The block
-is unconditionally executed. <code>begin; ...; end</tt> is equivalent
-to <tt>if true; ...; end</tt>.
+The block is unconditionally executed. `begin; ...; end` is equivalent
+to `if true; ...; end`.
 
-\c begin is used to group a number of commands into a block.
+`begin` is used to group a number of commands into a block.
 This allows the introduction of a new variable scope, redirection of the input or
 output of a set of commands as a group, or to specify precedence when
-using the conditional commands like \c and.
+using the conditional commands like `and`.
 
-\c begin does not change the current exit status.
+`begin` does not change the current exit status.
 
 \subsection begin-example Example
 
@@ -24,26 +25,26 @@ The following code sets a number of variables inside of a block
 scope. Since the variables are set inside the block and have local
 scope, they will be automatically deleted when the block ends.
 
-<pre>
+\fish
 begin
-	set -l PIRATE Yarrr
-	...
+    set -l PIRATE Yarrr
+    ...
 end
+
+echo $PIRATE
 # This will not output anything, since the PIRATE variable went out
 # of scope at the end of the block
-echo $PIRATE
-</pre>
+\endfish
 
 In the following code, all output is redirected to the file out.html.
 
-<pre>
+\fish
 begin
-	echo $xml_header
-	echo $html_header
-	if test -e $file
-		...
-	end
-	...
-
-end &gt; out.html
-</pre>
+    echo $xml_header
+    echo $html_header
+    if test -e $file
+        ...
+    end
+    ...
+end > out.html
+\endfish
-- 
cgit v1.2.3