biolocal:Write the script documentation

From Wiki CEINGE

Jump to: navigation, search

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/

The documentation have to be placed in the same directory of its script.

Tools documentation is at http://clr55.ceinge.unina.it/biodevdoc/.projects/tools/

Library documentation is at http://clr55.ceinge.unina.it/biodevdoc/.lib/lib_0.1/objects/

Personal tools