Merge pull request #22 from Neozaru/master

Added Doxyfile for future documentation
2014-06-04 10:16:24 -04:00 · 2014-06-04 10:16:24 -04:00 · cf8ac2c8f1
parent 24b4f47413 65f4782efd
commit cf8ac2c8f1
2 changed files with 2327 additions and 1 deletions
--- a/2310
+++ b/2310
--- a/16
+++ b/16
@ -30,3 +30,19 @@ cmake -G "Visual Studio 11 Win64" ..

 And then do Build.
 Good luck!
+
+
+Build documentation (Doxygen) :
+Pequired Packages:
+* doxygen
+* graphviz (optional)
+
+From root code directory, execute :
+
+    doxygen Doxyfile
+
+If you have installed *graphviz*, you can also generate in-doc diagrams :
+
+    HAVE_DOT=YES doxygen Doxyfile
+
+The output will go in **doc/html/**