Feature Request: Add @license keyword

reconquest / shdoc

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

MIT License

294 stars 63 forks source link

Feature Request: Add @license keyword #37

Open JonTheNiceGuy opened 3 years ago

JonTheNiceGuy commented 3 years ago

It would be useful to have a file-level @license keyword, e.g. @license MIT or @license [WTFPL](LICENSE.md)

hyperupcall commented 2 years ago

This is an interesting idea, but I'm not sure how useful this is, as license parsers already determine the license from comments. I personally wouldn't want to add a feature that is already replaceable with an existing thing

rbairwell commented 2 years ago

I'd appreciate this feature as well - if only to reduce the number of parsers needed for a file and secondly so I hardly need to think which language I'm writing documentation for (as I'm from a PHP background I tend to use PHPDoc which does support @license - but both PHPDoc and SHDoc seem to be JavaDoc inspired which - admittedly - doesn't appear to support it)