From 05685988739382343031b1fb2c94b74699f4ff7e Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Thu, 24 Aug 2017 19:24:34 +0100
Subject: Improving documentation further.

Made base README the main page.
---
 .gitignore                   |  3 +++
 README.md                    |  2 +-
 docs/Doxyfile                | 10 ++++++----
 docs/mainpage.dox            |  7 -------
 include/YAGE/Math/matrix.hpp |  4 ++--
 include/YAGE/yage.hpp        | 21 +++++++++++++++++++++
 6 files changed, 33 insertions(+), 14 deletions(-)
 delete mode 100644 docs/mainpage.dox

diff --git a/.gitignore b/.gitignore
index 76595e59..0bba4a3c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,9 @@ build_*
 CMakeFiles
 Testing
 
+# specific directory to ignore
+/html
+
 # extensions to ignore
 *.o
 *.out
diff --git a/README.md b/README.md
index 96a0ad70..76e2ecbd 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-YAGE
+YAGE {#mainpage}
 ====
 
 Introduction
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 2afa6331..29c50bdd 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -790,7 +790,10 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  =
+INPUT                  = docs \
+                         src \
+                         include \
+                         README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -873,7 +876,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = docs/README.md
 
 # 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
@@ -889,8 +892,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = */googletest/* \
-                         */build/*
+EXCLUDE_PATTERNS       =
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
diff --git a/docs/mainpage.dox b/docs/mainpage.dox
deleted file mode 100644
index 8a834554..00000000
--- a/docs/mainpage.dox
+++ /dev/null
@@ -1,7 +0,0 @@
-/** @mainpage
-  *
-  * YAGE
-  * ====
-  *
-  * This is the main page of YAGE, the game engine.
-  */
diff --git a/include/YAGE/Math/matrix.hpp b/include/YAGE/Math/matrix.hpp
index 78cb4008..fc81fa34 100644
--- a/include/YAGE/Math/matrix.hpp
+++ b/include/YAGE/Math/matrix.hpp
@@ -112,7 +112,7 @@ public:
         return rowMatrix;
     }
 
-    /** Get a specific column in a column vector. 
+    /** Get a specific column in a column vector.
       *
       * @param col Column number to be returned.
       * @return Column Matrix of the selected column.
@@ -409,7 +409,7 @@ Matrix<M, Q, T> multiply(const Matrix<M, N, T> &m1, const Matrix<P, Q, T> &m2)
         throw std::runtime_error(
             "Matrices don't have the right dimensions for multiplication");
     }
-    
+
     Matrix<M, Q, T> res;
 
     /// Performs multiplication by getting the rows and columns, transposing
diff --git a/include/YAGE/yage.hpp b/include/YAGE/yage.hpp
index f7b32683..13d6d560 100644
--- a/include/YAGE/yage.hpp
+++ b/include/YAGE/yage.hpp
@@ -6,6 +6,11 @@
  * ----------------------------------------------------------------------------
  */
 
+/** @file Includes all the headers in the main YAGE project.
+  *
+  * This does not include
+  */
+
 #ifndef YAGE_HPP
 #define YAGE_HPP
 
@@ -25,13 +30,29 @@
 
 #include <stdexcept>
 
+/** Project namespace.
+  *
+  * Avoids collision as all the classes and global functions are wrapped in.
+  * it.
+  */
 namespace yage
 {
 
+/** Initializes YAGE.
+  *
+  * This is only there to initialize SDL2.
+  *
+  * @return Returns true if the initialization was successful.
+  */
 bool init()
 {
     return SDL_Init(SDL_INIT_VIDEO);
 }
+
+/** Quit and cleanup YAGE
+  *
+  * SDL2 needs to clean itself up.
+  */
 void quit()
 {
     SDL_Quit();
-- 
cgit