SPELL=bashdoc VERSION=0.2 SOURCE=$SPELL-$VERSION.tar.bz2 SOURCE_DIRECTORY=$BUILD_DIRECTORY/$SPELL-$VERSION SOURCE_URL[0]=http://download.sourcemage.org/projects/bashdoc/$SOURCE SOURCE_GPG=gurus.gpg:$SOURCE.sig:UPSTREAM_KEY WEB_SITE=http://wiki.sourcemage.org/bashdoc ENTERED=20040223 LICENSE=GPL SHORT="A tool for generating Bash documentation from the Source Mage libraries." cat << EOF This spell installs bashdoc tooling for generationg Bash documentation from code. It also runs a script generate and install all Source Mage GNU/Linux documentation that is available in our code. Documentation is viewable at /usr/share/doc/sourcemageapidocs/index.html. Enjoy! Quick reference for docing Source Mage project code (each lib/function): ======================================================================== @param: when order is important @Arguments: when order is unimportant @Stdout: what is dumped to stdout by this function @Stderr: whe is dumped to stderr @Stdin: what is expected from stdin @return: what the return values mean @Globals: global variables used Some others are that are used: @Type API: if it's an API function @Synopsis @Copyright @License Keep in mind that <@function some_function> will make a link to the function in the docs. The function is limited to being in the same file. Any funny symbols will not be translated for you, so putting in the comments would be a no-no. Brought to you by Paul Mahon! EOF