Code-Slave / bashdoc

The bashdoc script is a frontend which parse a bash file and create a documentation in specified format. This script works similar to javadoc for java projects, but use reStructuredText as middle language to provide the final document.

Home Page:http://github.com/ajdiaz/bashdoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

======
README
======

This script is a frontend for various awk(1) scripts which parse a bash
script (file) and create a documentation in specified format. This script
works similar to javadoc for java projects.

In library directory you can found an example of basic backend for
gawk.

Requirements
============
bashdoc is written in bash, and require almost bash >= 3.0,
gawk >= 3.1.5, docutils >= 0.4 and GNU coreutils.

Andrés J. Díaz <ajdiaz@connectical.net>

About

The bashdoc script is a frontend which parse a bash file and create a documentation in specified format. This script works similar to javadoc for java projects, but use reStructuredText as middle language to provide the final document.

http://github.com/ajdiaz/bashdoc


Languages

Language:Awk 68.2%Language:Shell 31.8%