biolocal:Write the script documentation
From Wiki CEINGE
(Difference between revisions)
| Revision as of 18:27, 4 February 2008 (edit) Luca (Talk | contribs) (New page: The script documentation should be written according to php-documentator sintax. ([http://www.phpdoc.org see php documentator web-site].) These are command line examples which create auto...) ← Previous diff |
Revision as of 18:28, 4 February 2008 (edit) (undo) Luca (Talk | contribs) Next diff → |
||
| Line 9: | Line 9: | ||
| Currently the generated documentation is stored on clr55.ceinge.unina.it and can be reached on http://clr55.ceinge.unina.it/biodevdoc/ | 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 " | + | For example the documentation of annotator objects are in http://clr55.ceinge.unina.it/biodevdoc/.lib/lib_0.1/objects/ in "annotatorlib" package. |
Revision as of 18:28, 4 February 2008
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 "annotatorlib" package.
