EMMAWiki/DeveloperDocumentation/APIDocumentation

Documentation of concepts

See ConceptDocumentation for an introduction to basic programming concepts and diagrams. This page also describes how the backend-code and core classes are generated.

EMMA API-Documetation

This section is mainly addressing core developers and developers wishing to extend or customize EMMA. There are several levels of API-documentation available.

O2DBI Server Documentation

Automatically generated HTML-documentation of the O2DBI-Backend modules. This includes all modules under the share/perl/EMMA/ hierarchy.

MAGE-OM Documentation

Sorted by packages:

• Auto generated HTML-documentation of the MAGE-OM classes from POD. If you add POD to your modules the documentation will automatically appear here.
• Auto generated PDF-documentation of the MAGE-OM classes generated from the HTML-file.

External documentation:

• MAGE-OM as a set of hyperlinked diagrams (Mozilla browser required)

Generating Documentation

To regenerate the HTML-documetation:

• Use the script:

cd CVS/bioinfo/emma2/share/exec/
./create_html_docs.pl