biolocal:Write the script documentation
From Wiki CEINGE
(Difference between revisions)
| Revision as of 16:48, 6 February 2008 (edit) Luca (Talk | contribs) m ← Previous diff |
Current revision (12:50, 18 February 2008) (edit) (undo) Gianluca (Talk | contribs) m (Bioinfolocal:Write the script documentation moved to biolocal:Write the script documentation: moving to the right namespace) |
Current revision
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/
