X-Git-Url: http://git.euphorik.ch/index.cgi?a=blobdiff_plain;f=WCudaMSE%2FTuto_Doxy%2Fsrc%2Fdoc%2FDOC_ROOT_Animals.h;fp=WCudaMSE%2FTuto_Doxy%2Fsrc%2Fdoc%2FDOC_ROOT_Animals.h;h=9901c46b01d830ba38abd769975eb40cd5ce131f;hb=8d08c12b29c2a14684f35c023ee39e694bb80d25;hp=0000000000000000000000000000000000000000;hpb=226de81f7e1f1fbf4ac79d0d089e8a05ec7159a0;p=GPU.git

diff --git a/WCudaMSE/Tuto_Doxy/src/doc/DOC_ROOT_Animals.h b/WCudaMSE/Tuto_Doxy/src/doc/DOC_ROOT_Animals.h
new file mode 100755
index 0000000..9901c46
--- /dev/null
+++ b/WCudaMSE/Tuto_Doxy/src/doc/DOC_ROOT_Animals.h
@@ -0,0 +1,65 @@
+#ifndef APIANIMALS_H_
+#define APIANIMALS_H_
+
+#include "Animals.h"
+#include "Cat.h"
+
+
+/*----------------------------------------------------------------------*\
+ |*			Declaration 					*|
+ \*---------------------------------------------------------------------*/
+
+/*--------------------------------------*\
+ |*		Public			*|
+ \*-------------------------------------*/
+
+
+/*! @mainpage Animals api documentation
+ *
+ * @section Introduction
+ * The purpose this project is to explain how to use the doxygen documentation
+ *
+ * @section Installation
+ * <pre>
+ * Doxygen and graphviz are already installed on Cuda1 and Cuda2.
+ * Doxygen is the software to generate the documentation. Graphviz the soft to generate the UML graph and it is optional.
+ *
+ * If you want to install it on Ubuntu:
+ * 	sudo apt-get install doxygen
+ * 	sudo apt-get isntall graphviz
+ *
+ * You can find on internet installers for Windows!
+ * </pre>
+ *
+ * @section Usage
+ * Doxygen is a javadoc syntax like. Look into the project to understand how to comment methods, variables, class, files, etc.
+ *
+ * You can parametrize the output with the makefile BUILDER/makefile/public/doc/doxygen.mk.<br>
+ * It contains some of the parameters that you can change.
+ *
+ * For the <b>general</b> documentation, you can use <b>html</b> markup language.
+ * <table border="1 solid" margin="10px">
+ * <tr>
+ * <td>Inside a table
+ * </td>
+ * <td>2nd cell
+ * </td>
+ * </tr>
+ * </table>
+ *
+ *
+ * @section Compilation
+ * You can also include image in the documentation.
+ *
+ * <img src="http://www.stack.nl/~dimitri/doxygen/manual/infoflow.png">
+ *
+ * @section Reference
+ * You can find more about doxygen on this website: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
+ */
+
+
+#endif 
+
+/*----------------------------------------------------------------------*\
+ |*			End	 					*|
+ \*---------------------------------------------------------------------*/