Anvil / bash-doxygen

A doxygen filter for bash scripts
Do What The F*ck You Want To Public License
92 stars 24 forks source link

Add stanza to match variable assignments #8

Open awmyhr opened 7 years ago

awmyhr commented 7 years ago

Hello, in writing POSIX-compliant scripts, we are unable to use the 'declare' syntax, thus I have added a stanza to match simple variable assignments. Variables matched in this way are given a type of 'String'. This allows Doxygen to catch and add these to generated documentation. Though it almost certainly results in multiple matches, in my (admittedly limited) testing, the end-result looks fine.

Though this project is 'bash-doxygen' and not 'posix-doxygen', I believe this to be of value to many bash users as well, since it is not really common practice to use the 'declare' keyword from what I have seen.