|
3 | 3 | bash-doxygen
|
4 | 4 | ============
|
5 | 5 |
|
6 |
| -A basic doxygen filter (originaly written in GNU sed) allowing you to |
| 6 | +A basic doxygen filter (originally written in GNU sed) allowing you to |
7 | 7 | add inline-documentation to your bash shell scripts.
|
8 | 8 |
|
9 | 9 | ### Supported shell syntaxes
|
10 | 10 |
|
11 | 11 | * All lines starting with a `## ` (without any leading blanks) are
|
12 |
| - provided to doxygen. You can use all doxygen command you want in |
| 12 | + passed to doxygen. You can use all the doxygen commands you want in |
13 | 13 | those lines. (see [doxygen
|
14 | 14 | documentation](http://www.stack.nl/~dimitri/doxygen/manual/commands.html)).
|
15 | 15 |
|
16 | 16 | * Some top level declarations will be recognized if you use the
|
17 |
| - `declare` primitive: |
| 17 | + `declare` primitive: |
18 | 18 | * `declare -a` for arrays
|
19 | 19 | * `declare -A` for associative arrays
|
20 | 20 | * `declare -i` for integers
|
21 | 21 | * Any other top-level `declare` statement will consider variable is a string.
|
22 |
| - * Those additionnal declaration attributes can be combined with -A/-a/-i/<none>: |
| 22 | + * Those additional declaration attributes can be combined with -A/-a/-i/<none>: |
23 | 23 | * `declare -l` will mark the variable as LowerCase
|
24 | 24 | * `declare -u` will mark the variable as UpperCase
|
25 | 25 | * `declare -x` will mark the variable as Exported
|
26 | 26 | * `declare -r` will mark the variable as ReadOnly
|
27 |
| - * Additionnaly, declaring a variable with an `export` statement will |
| 27 | + * Additionally, declaring a variable with an `export` statement will |
28 | 28 | also be recognized and the variable will be marked as an Exported
|
29 | 29 | String.
|
30 | 30 |
|
31 | 31 | * Functions declaration will be recognized if all these conditions are met:
|
32 | 32 | 1. a `## @fn` line is found above the function declaration,
|
33 | 33 | 2. the function is declared either with or without the non-posix
|
34 | 34 | `function` keyword, but always with `()`.
|
35 |
| - 3. the body-opening `{` char is on the same line than the |
| 35 | + 3. the body-opening `{` char is on the same line as the |
36 | 36 | `funcname()` instruction.
|
37 | 37 |
|
38 | 38 | How to use it
|
|
59 | 59 | FAQ
|
60 | 60 | ---
|
61 | 61 |
|
62 |
| -Q. Does it actually work ? |
| 62 | +Q. Does it actually work ? |
63 | 63 | A. The [bash-argsparse](https://github.com/Anvil/bash-argsparse)
|
64 | 64 | project uses this filter. Check
|
65 | 65 | [the result](http://argsparse.livna.org/doxygen/). Click on the
|
66 | 66 | links. See by yourself.
|
67 | 67 |
|
68 |
| -Q. Is it rock-solid ? |
| 68 | +Q. Is it rock-solid ? |
69 | 69 | A. No.
|
70 | 70 |
|
71 |
| -Q. Do you accept patches ? |
| 71 | +Q. Do you accept patches ? |
72 | 72 | A. Definitely.
|
73 | 73 |
|
74 | 74 | Q. Why is the project named bash-doxygen while the filter is named
|
75 |
| -doxygen-bash ? |
| 75 | +doxygen-bash ? |
76 | 76 | A. Yeah, haha. Seriously.
|
77 | 77 |
|
78 |
| -Q. Can i include the doxygen-bash.sed file in my own tarball ? |
79 |
| -A. See the COPYING file. |
| 78 | +Q. Can I include the doxygen-bash.sed file in my own tarball ? |
| 79 | +A. See the [COPYING](COPYING) file. |
80 | 80 |
|
81 |
| -Q. Dude. sed ? Seriously ? |
| 81 | +Q. Dude. sed ? Seriously ? |
82 | 82 | A. Are you.. Jealous ?
|
83 | 83 |
|
84 |
| -Q. ... ? |
| 84 | +Q. ... ? |
85 | 85 | A. Don't you dare !
|
0 commit comments