Skip to content
This repository was archived by the owner on Mar 12, 2021. It is now read-only.

Documentation

Miguel Martin edited this page Aug 7, 2013 · 5 revisions

To get the documentation for anax, you can either:

  • Generate your own documentation
  • Download pre-generated documentation from the downloads section

The code is currently documented to a fairly-good standard, however there may be grammar/spelling issues with the documentation. Please submit any issues here.

Using Doxygen

Instead of downloading the documentation from the downloads section, I suggest you build the documentation yourself. In order to build the documentation, you must have doxygen installed, you can simply open the Doxyfile within the doc/ directory and generate the documentation using the program.

Help out with the Documentation

You are more than welcome to help out with writing/fixing the documentation in the code. Alternatively you can add grammar/spelling issues here (especially if some things don't make any sense).