WCudaMSE/Tuto_Doxy/src/doc/DOC_ROOT_Animals.h

   1 #ifndef APIANIMALS_H_
   2 #define APIANIMALS_H_
   3
   4 #include "Animals.h"
   5 #include "Cat.h"
   6
   7
   8 /*----------------------------------------------------------------------*\
   9  |*                     Declaration                                     *|
  10  \*---------------------------------------------------------------------*/
  11
  12 /*--------------------------------------*\
  13  |*             Public                  *|
  14  \*-------------------------------------*/
  15
  16
  17 /*! @mainpage Animals api documentation
  18  *
  19  * @section Introduction
  20  * The purpose this project is to explain how to use the doxygen documentation
  21  *
  22  * @section Installation
  23  * <pre>
  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.
  26  *
  27  * If you want to install it on Ubuntu:
  28  *      sudo apt-get install doxygen
  29  *      sudo apt-get isntall graphviz
  30  *
  31  * You can find on internet installers for Windows!
  32  * </pre>
  33  *
  34  * @section Usage
  35  * Doxygen is a javadoc syntax like. Look into the project to understand how to comment methods, variables, class, files, etc.
  36  *
  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.
  39  *
  40  * For the <b>general</b> documentation, you can use <b>html</b> markup language.
  41  * <table border="1 solid" margin="10px">
  42  * <tr>
  43  * <td>Inside a table
  44  * </td>
  45  * <td>2nd cell
  46  * </td>
  47  * </tr>
  48  * </table>
  49  *
  50  *
  51  * @section Compilation
  52  * You can also include image in the documentation.
  53  *
  54  * <img src="http://www.stack.nl/~dimitri/doxygen/manual/infoflow.png">
  55  *
  56  * @section Reference
  57  * You can find more about doxygen on this website: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
  58  */
  59
  60
  61 #endif
  62
  63 /*----------------------------------------------------------------------*\
  64  |*                     End                                             *|
  65  \*---------------------------------------------------------------------*/