biolocal:Write the script documentation

Revision as of 18:27, 4 February 2008 by Luca (Talk | contribs)

The script documentation should be written according to php-documentator sintax. (see php documentator web-site.)

These are command line examples which create automatic generated documentations:

 phpdoc -o HTML:frames:earthli -d [scripts directory] -t [output directory]

 phpdoc -o HTML:frames:earthli -f [script file] -t [output directory]

Currently the generated documentation is stored on clr55.ceinge.unina.it and can be reached on http://clr55.ceinge.unina.it/biodevdoc/

For example the documentation of annotator objects are in http://clr55.ceinge.unina.it/biodevdoc/.lib/lib_0.1/objects/ in "annotator" package.