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/case.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/case.txt')
| -rw-r--r-- | doc_src/case.txt | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc_src/case.txt b/doc_src/case.txt index b5601cdb..aab24d53 100644 --- a/doc_src/case.txt +++ b/doc_src/case.txt @@ -1,18 +1,20 @@ \section case case - conditionally execute a block of commands \subsection case-synopsis Synopsis -<tt>switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end</tt> +\fish{syn} +switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end +\endfish \subsection case-description Description -\c switch performs one of several blocks of commands, depending on whether -a specified value equals one of several wildcarded values. \c case is used -together with the \c switch statement in order to determine which block should +`switch` performs one of several blocks of commands, depending on whether +a specified value equals one of several wildcarded values. `case` is used +together with the `switch` statement in order to determine which block should be executed. -Each \c case command is given one or more parameters. The first \c case +Each `case` command is given one or more parameters. The first `case` command with a parameter that matches the string specified in the -switch command will be evaluated. \c case parameters may contain +switch command will be evaluated. `case` parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames. @@ -29,7 +31,7 @@ against the parameter. If the variable \$animal contains the name of an animal, the following code would attempt to classify it: -<pre> +\fish switch $animal case cat echo evil @@ -43,8 +45,8 @@ switch $animal case '*' echo I have no idea what a $animal is end -</pre> +\endfish -If the above code was run with \c \$animal set to \c whale, the output -would be \c mammal. +If the above code was run with `$animal` set to `whale`, the output +would be `mammal`. |