IGetDBWiki/GettingStarted/Documentation

Documentation

As developers we are also responsible for documentation. Please let's try the following conventions:

• document your code
• use the specific documentation tools of the domain
• use JavaDoc comments for documenting Java classes
• when using Eclipse use the Java formatter profile "Java Conventions"
• use POD for documenting Perl module
• use perlmodule Pod::Usage for documenting perl-scripts
• each script needs a usage message (see above)
• O2DBI-documentation (will create POD-doku for server classes)

The other main source is the perldoc documentation. The generated O2DBI-servermodules are pod documented. You can read them with:

perldoc module.pm

Other modules may also have pod-documentation but this is not guaranteed. The documentation found can also be incomplete or rather outdated. If you wish to generate the documentation for all perl modules you can do so be executing the shell script:

CVS/bioinfo/igetdb/share/exec/create_html_docs.pl

It generates an HTML version of the perldoc documentation in the directory 'CVS/bioinfo/igetdb/share/doc/html'.

Additional documentation can be found in CVS/bioinfo/igetdb/share/doc.