====== Doxygen documentation ======

The doxygen generated pages might be useful for exploring the code an when you want to work with Auryn other than just trying out some of the examples (you find an online version of it [[http://fzenke.net/auryn/doxygen/current/annotated.html|here]]).

To build the ''doxygen'' documentation ensure you have doxygen installed. Under debian like distributions that means to install
<code>
sudo apt-get install graphviz doxygen
</code>

and then to generate the html documentation under ''doc/html'' run
<code>
cd auryn/src
doxygen
</code>

Starting from version v0.8 you need to run:
and then to generate the html documentation under ''doc/html'' run
<code>
cd auryn/doc
doxygen
</code>

This will generate the doxygen documentation an place it in the ''auryn/doc'' directory.