compatablity ? and ?shdoc.md!

[dubiouscript]

shdoc is a documentation generator for bash/zsh/sh for generating API documentation in Markdown from shell scripts source.

shdoc parses annotations in the beginning of a given file and alongside function definitions, and creates a markdown file with ready to use documentation.

give the above quote from readme.md it appears that any language supporting '# comment '
should work

unless some other reason exist making ssb exclusive to bash/zsh/sh?

... with the above in mind has any consideration been given to

• documenting the shdoc awk script !
• expanding the stated compatibility to "any language supporting '# comment ' " ?

[kovetskiy]

I'm not sure I've understood your question.

shdoc does support comments starting with #, and it doesn't support documenting awk scripts.

[dubiouscript]

I'm not sure I've understood your question.

(it would help me clarify if you could explain) what is unclear ?

shdoc does support comments starting with #

it doesn't support documenting awk scripts.

if awk scripts use '#' comment ( AFAIK it dose )
for what reason(s?) do you consider awk script's unsupported ?

eg
you have no interest in supporting other lang with # comment
or no time to support other lang with # comment

something technical ( i have not thought of )

---

edit
while reading through https://github.com/reconquest/shdoc/blob/master/README.md i considered it might have been created in part from https://github.com/reconquest/shdoc/blob/master/shdoc

probably because in the past i read through https://github.com/bashup/mdsh ( Multi-lingual, Markdown-based Literate Programming)

which notes
# This file is automatically generated from mdsh.md

and thought that perhaps shdoc/readme.md
might be (inpart) composed of comments from ./shdoc

after finding

• this is not the case
• shdoc is written in awk

i wandered if some technical reason exists it was not possible/practical to use shdoc outside of bash/zsh/sh
...
"hashdoc" , only adds an extra 2 char :p

[kovetskiy]

I have not tested it on awk, may be it works fine