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

View File

@@ -1,13 +1,15 @@
\section random random - generate random number
\subsection random-synopsis Synopsis
<tt>random [SEED]</tt>
\fish{syn}
random [SEED]
\endfish
\subsection random-description Description
\c random outputs a random number from 0 to 32766, inclusive.
`random` outputs a random number from 0 to 32766, inclusive.
If a \c SEED value is provided, it is used to seed the random number
If a `SEED` value is provided, it is used to seed the random number
generator, and no output will be produced. This can be useful for debugging
purposes, where it can be desirable to get the same random number sequence
multiple times. If the random number generator is called without first
@@ -17,9 +19,9 @@ seeding it, the current time will be used as the seed.
The following code will count down from a random number to 1:
<pre>
\fish
for i in (seq (random) -1 1)
echo $i
sleep
echo $i
sleep
end
</pre>
\endfish