From 9aba276757243c426d5e18536779f1bf277b4c91 Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Fri, 28 Jul 2017 00:41:40 +0100
Subject: Adding update_docs script and updated documentation

---
 docs/Doxyfile                |  3 ++-
 include/YAGE/Math/matrix.hpp | 37 ++++++++++++++++++++++++++++---------
 scripts/update_docs          | 13 +++++++++++++
 3 files changed, 43 insertions(+), 10 deletions(-)
 create mode 100755 scripts/update_docs

diff --git a/docs/Doxyfile b/docs/Doxyfile
index db32bfad..07f310d7 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -873,7 +873,8 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = ./test \
+                         ./build \
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
diff --git a/include/YAGE/Math/matrix.hpp b/include/YAGE/Math/matrix.hpp
index 42f5ebbc..87347f60 100644
--- a/include/YAGE/Math/matrix.hpp
+++ b/include/YAGE/Math/matrix.hpp
@@ -6,6 +6,17 @@
  * ----------------------------------------------------------------------------
  */
 
+/** \file matrix.hpp
+ * \brief Templated matrix class
+ * 
+ * Matrix
+ * ======
+
+ * This is a very general matrix class that can then be inherited by
+ * vectors and other similar data structures to minimize code 
+ * density.
+ */
+
 #ifndef YAGE_MATH_MATRIX_HPP
 #define YAGE_MATH_MATRIX_HPP
 
@@ -21,14 +32,17 @@ namespace yage
 
 template<int Rows, int Cols, class Type> class Matrix;
 
-// includes implementation details that should not be accessible to the user
+/** \namespace detail
+ * \brief Detail namespace
+ *
+ * Detail Namespace
+ * ================
+ *
+ * This is the namespace used for implementation detail.
+ */
 namespace detail
 {
 
-// Row class
-//
-// Used to implement the double square bracket operator and be able
-// to return the value by reference of the array.
 template<int Rows, int Cols, class Type> class Row
 {
 private:
@@ -54,10 +68,15 @@ public:
 
 } // detail
 
-// Matrix class
-//
-// Implements the base Matrix class that is inherited by other classes to make them more
-// specific.
+/** \class Matrix
+ * \brief Base matrix class
+ *
+ * Matrix class
+ * ============
+ *
+ * This is the base matrix class that can be used by all the other matrix
+ * like data structures.
+ */
 template<int Rows=4, int Cols=4, class Type=double> class Matrix
 {
 	// friended with the row class so that it can access protected member data
diff --git a/scripts/update_docs b/scripts/update_docs
new file mode 100755
index 00000000..6864d6d3
--- /dev/null
+++ b/scripts/update_docs
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+doxygen ./docs/Doxyfile
+git clone -b gh-pages git@github.com:ymherklotz/YAGE
+cd YAGE/
+git rm -rf *
+mv ../html/* .
+rm -rf ../html
+git add -A
+git commit -a -m 'Updating docs'
+git push origin gh-pages
+cd ..
+rm -rf YAGE
-- 
cgit