views:

218

answers:

3

Is there an open source or public domain framework that can document shell scripts similar to what JavaDoc produces? I don't need to limit this just to a specific flavor of shell script, ideally I would like a generic framework for documenting API or command line type commands on a web page that is easy to extend or even better is self documenting.

A: 

You might consider Doxygen. While it's mostly used to document C-ish languages like JavaDoc, you can probably come up with a setup that will work for shell scripts with a bit of wrangling.

bmdhacks
+2  A: 

If you have Perl, here is an example of someone who used Perl's POD system for documentation of a shell script.

Steve
A: 

The POD way moved. It's now here: http://bahut.alma.ch/2007_08_01_archive.html

AndréB