Skip to content

Commit 862200c

Browse files
committed
Fix some typos.
1 parent 243823d commit 862200c

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,36 @@
33
bash-doxygen
44
============
55

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
77
add inline-documentation to your bash shell scripts.
88

99
### Supported shell syntaxes
1010

1111
* 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
1313
those lines. (see [doxygen
1414
documentation](http://www.stack.nl/~dimitri/doxygen/manual/commands.html)).
1515

1616
* Some top level declarations will be recognized if you use the
17-
`declare` primitive:
17+
`declare` primitive:
1818
* `declare -a` for arrays
1919
* `declare -A` for associative arrays
2020
* `declare -i` for integers
2121
* 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>:
2323
* `declare -l` will mark the variable as LowerCase
2424
* `declare -u` will mark the variable as UpperCase
2525
* `declare -x` will mark the variable as Exported
2626
* `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
2828
also be recognized and the variable will be marked as an Exported
2929
String.
3030

3131
* Functions declaration will be recognized if all these conditions are met:
3232
1. a `## @fn` line is found above the function declaration,
3333
2. the function is declared either with or without the non-posix
3434
`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
3636
`funcname()` instruction.
3737

3838
How to use it
@@ -59,27 +59,27 @@ Yes.
5959
FAQ
6060
---
6161

62-
Q. Does it actually work ?
62+
Q. Does it actually work ?
6363
A. The [bash-argsparse](https://github.com/Anvil/bash-argsparse)
6464
project uses this filter. Check
6565
[the result](http://argsparse.livna.org/doxygen/). Click on the
6666
links. See by yourself.
6767

68-
Q. Is it rock-solid ?
68+
Q. Is it rock-solid ?
6969
A. No.
7070

71-
Q. Do you accept patches ?
71+
Q. Do you accept patches ?
7272
A. Definitely.
7373

7474
Q. Why is the project named bash-doxygen while the filter is named
75-
doxygen-bash ?
75+
doxygen-bash ?
7676
A. Yeah, haha. Seriously.
7777

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

81-
Q. Dude. sed ? Seriously ?
81+
Q. Dude. sed ? Seriously ?
8282
A. Are you.. Jealous ?
8383

84-
Q. ... ?
84+
Q. ... ?
8585
A. Don't you dare !

0 commit comments

Comments
 (0)