EMMAWiki/DeveloperDocumentation/APIDocumentation: Difference between revisions
Jump to navigation
Jump to search
imported>JomunaChoudhuri No edit summary |
m (6 revisions) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- ##language:en --> | <!-- ##language:en --> | ||
== 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 == | == EMMA API-Documetation == | ||
This section is mainly | This section is mainly addressing core developers and developers wishing to extend or customize EMMA. | ||
There are several levels of API-documentation available. | There are several levels of API-documentation available. | ||
=== O2DBI Server Documentation === | === O2DBI Server Documentation === | ||
Automatically generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/ HTML-documentation] of the O2DBI-Backend modules. | |||
This includes all modules under the share/perl/EMMA/ hierarchy. | This includes all modules under the share/perl/EMMA/ hierarchy. | ||
=== MAGE-OM Documentation === | === MAGE-OM Documentation === | ||
Sorted by packages: | Sorted by packages: | ||
* Auto generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/MAGE.html HTML-documentation of the MAGE-OM classes] from POD. If you | * Auto generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/MAGE.html HTML-documentation of the MAGE-OM classes] from POD. If you add POD to your modules the documentation will automatically appear here. | ||
* Auto generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/MAGE.pdf PDF-documentation of the MAGE-OM classes] generated from the HTML-file | * Auto generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/MAGE.pdf PDF-documentation of the MAGE-OM classes] generated from the HTML-file. | ||
External documentation: | External documentation: | ||
| Line 19: | Line 23: | ||
=== Generating Documentation === | === Generating Documentation === | ||
To regenerate the HTML-documetation: | |||
* Use the script: | * Use the script: | ||
<pre><nowiki> | <pre><nowiki> | ||
Latest revision as of 07:18, 26 October 2011
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