biolocal:Write the script documentation

(Difference between revisions)

Revision as of 16:48, 6 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/

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

Revision as of 16:47, 6 February 2008 (edit) Luca (Talk \| contribs) ← Previous diff		Revision as of 16:48, 6 February 2008 (edit) (undo) Luca (Talk \| contribs) m Next diff →
Line 12:		Line 12:

	Tools documentation is at http://clr55.ceinge.unina.it/biodevdoc/.projects/tools/		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/		Library documentation is at http://clr55.ceinge.unina.it/biodevdoc/.lib/lib_0.1/objects/