Add support for @option tag (partially close #51) - Githubissues

reconquest / shdoc

Documentation generator for shell scripts (bash, sh, zsh). Javadoc for shell scripts.

MIT License

294 stars 63 forks source link

Add support for @option tag (partially close #51) #64

Closed landure closed 1 year ago

landure commented 1 year ago

This PR add support for @option tag for short and long options.

@option supports short and long options, separated by pipes. Options can have an argument specified between < and >.
If @option format is not recognized by the somewhat complex regex, it is processed as a "bad" option, and outputted in a unstyled list. A warning is displayed on stderr.
@arg without $[0-9] or $@ is processed as an @option tag, and a warning is displayed on stderr.

It also revamp description and titles processing to limit the use of "\n" in code.

kovetskiy commented 1 year ago

Hey, thank you for your contribution and your patience. I have no idea how I missed this great work. Thanks again for your time!