Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add bullet point list for style rules

...

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

 

TODO:  
  •  fill or delete this, depending on what is applicable here
  •  Do we have a link to current output that we can point to?

...

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

  • (to be continued...)

...