EMMAWiki/DeveloperDocumentation/APIDocumentation: Difference between revisions

Revision as of 10:33, 12 April 2005

Documetation 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 adressing core developers and developers wishing to extend or customize EMMA. There are several levels of API-documentation available.

O2DBI Server Documentation

Atomatically 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 ad POD to your modules the documentation will automaticaally 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

@@ Line 1: / Line 1: @@
 __NOTOC__
 <!-- ##language:en -->
+== Documetation 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 adressing core developers and developers wishing to extend or customize EMMA.
@@ Line 19: / Line 23: @@
 === Generating Documentation ===
+To regenerate the HTML-documetation:
 * Use the script:
 <pre><nowiki>