Corinthia uses Doxygen for code documentation.

A short primer can be found here. 

Generating the Doxygen Documentation

The following commands will generate a local incubator-corinthia/DocFormats/doc/html/index.html file  that you can use as a starting point for browsing through the generated source documentation:

The Documented:

Change into directory DocFormats; then, do: doxygen doxygen.cfg

Everything, including the undocumented:

Change into directory DocFormats; then, do: doxygen doxygen-extract-all.cfg

Corinthia specific style rules

• The Javadoc style is used for marking comment blocks: /** ... */

• (to be continued...)