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/count.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/count.txt')
| -rw-r--r-- | doc_src/count.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc_src/count.txt b/doc_src/count.txt index 7923ca00..1af00e00 100644 --- a/doc_src/count.txt +++ b/doc_src/count.txt @@ -1,17 +1,19 @@ \section count count - count the number of elements of an array \subsection count-synopsis Synopsis - <tt>count $VARIABLE</tt> +\fish{syn} +count $VARIABLE +\endfish \subsection count-description Description -<tt>count</tt> prints the number of arguments that were +`count` prints the number of arguments that were passed to it. This is usually used to find out how many elements an environment variable array contains. -\c count does not accept any options, including '-h'. +`count` does not accept any options, including '`-h`'. -\c count exits with a non-zero exit status if no arguments were passed +`count` exits with a non-zero exit status if no arguments were passed to it, and with zero if at least one argument was passed. \subsection count-example Example |