8 /*----------------------------------------------------------------------*\
10 \*---------------------------------------------------------------------*/
12 /*--------------------------------------*\
14 \*-------------------------------------*/
17 /*! @mainpage Animals api documentation
19 * @section Introduction
20 * The purpose this project is to explain how to use the doxygen documentation
22 * @section Installation
24 * Doxygen and graphviz are already installed on Cuda1 and Cuda2.
25 * Doxygen is the software to generate the documentation. Graphviz the soft to generate the UML graph and it is optional.
27 * If you want to install it on Ubuntu:
28 * sudo apt-get install doxygen
29 * sudo apt-get isntall graphviz
31 * You can find on internet installers for Windows!
35 * Doxygen is a javadoc syntax like. Look into the project to understand how to comment methods, variables, class, files, etc.
37 * You can parametrize the output with the makefile BUILDER/makefile/public/doc/doxygen.mk.<br>
38 * It contains some of the parameters that you can change.
40 * For the <b>general</b> documentation, you can use <b>html</b> markup language.
41 * <table border="1 solid" margin="10px">
51 * @section Compilation
52 * You can also include image in the documentation.
54 * <img src="http://www.stack.nl/~dimitri/doxygen/manual/infoflow.png">
57 * You can find more about doxygen on this website: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
63 /*----------------------------------------------------------------------*\
65 \*---------------------------------------------------------------------*/