EMMA 2 API Documentation: Difference between revisions
Jump to navigation
Jump to search
imported>MichaelDondrup No edit summary |
m (6 revisions) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
=== O2DBI Server Documentation === | === O2DBI Server Documentation === | ||
Atomatically generated [http://www-test.cebitec.uni-bielefeld.de/~mdondrup/INTERN/EMMA2/API-doc/ HTML-documentation] of the O2DBI-Backend | Atomatically 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. | |||
=== MAGE-OM Documentation === | === MAGE-OM Documentation === | ||
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 ad POD to your modules the documentation will automaticaally 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 | |||
External documentation: | |||
* [http://www.ebi.ac.uk/arrayexpress/Schema/MAGE/MAGE.htm MAGE-OM as a set of hyperlinked diagrams] (Mozilla browser required) | |||
=== Generating Documentation === | === Generating Documentation === | ||
* Use the script: | |||
<pre><nowiki> | |||
cd CVS/bioinfo/emma2/share/exec/ | |||
./create_html_docs.pl | |||
</nowiki></pre> | |||
Latest revision as of 07:13, 26 October 2011
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
- Use the script:
cd CVS/bioinfo/emma2/share/exec/ ./create_html_docs.pl