[Docs] Changing documentation

7 files changed, 60 insertions, 31 deletions

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 9feb54a8..21fdf62b 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -51,7 +51,7 @@ PROJECT_BRIEF          = "Yet Another Game Engine"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = @CMAKE_CURRENT_SOURCE_DIR@/docs/yage.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -1196,7 +1196,7 @@ HTML_EXTRA_FILES       =
 # Minimum value: 0, maximum value: 359, default value: 220.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_HUE    =  15
 
 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
 # in the HTML output. For a value of 0 the output will use grayscales only. A
@@ -1204,7 +1204,7 @@ HTML_COLORSTYLE_HUE    = 220
 # Minimum value: 0, maximum value: 255, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_SAT    = 200
 
 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
 # luminance component of the colors in the HTML output. Values below 100
@@ -1461,7 +1461,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = YES
+GENERATE_TREEVIEW      = NO
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
diff --git a/docs/logger.dox b/docs/logger.md
index 57f3a052..93debac8 100644
--- a/docs/logger.dox
+++ b/docs/logger.md
@@ -1,20 +1,21 @@
-/** @class yage::Logger
-
-## Logger
+Logger {#logger_guide}
+======
 
 Aynchronous logging is built into the YAGE library, which can be used to log events in the game
 and also debug the game by using the debug output that the game engine produces. This can help
 if for example, a texture is being loaded.
 
-### Log levels
+Log levels
+----------
 
 The logger has five different levels that can be assigned to a message. These are, from lowest to
-highest severity, `LogLevel::DEBUG`, `LogLevel::INFO`, `LogLevel::WARNING`, `LogLevel::ERROR`
-and `LogLevel::FATAL`. Messages that the developer then wants to write to the logs can take any
-of these severities and the developer can then decide what the minimum severity is that the logger
-should log. By default, the logger will log anything that is above `LogLevel::INFO`.
+highest severity, DEBUG, INFO, WARNING, ERROR and FATAL, which are of type @ref yage::LogLevel. 
+Messages that the developer then wants to write to the logs can take any of these severities 
+and the developer can then decide what the minimum severity is that 
+the logger should log. By default, the logger will log anything that is above @ref yage::LogLevel::INFO.
 
-### Using the Logger in your Game
+Using the Logger in your Game
+-----------------------------
 
 There are a few preprocessor definitions to make the use of the logger as simple as possible.
 First of all, there is a definition to get the instance of the current global logger, which
@@ -39,5 +40,3 @@ yLogWarning << "This is a warning";
 ```
 
 will print the message "This is a warning" with the severity of `LogLevel::WARNING`.
-
-*/
\ No newline at end of file
diff --git a/docs/main.md b/docs/main.md
new file mode 100644
index 00000000..1373b39d
--- /dev/null
+++ b/docs/main.md
@@ -0,0 +1,20 @@
+YAGE {#mainpage}
+====
+
+YAGE (Yet Another Game Engine) is a game engine that was written to learn about graphics
+and eventually be used to program games. It focuses mostly on tile based 2D games
+but it will eventually be expanded to handle orthographic views and finally full 3D.
+
+Guides
+------
+
+Below are some guides for different aspects of the game engine and how to use it.
+
+- [Sprite Batching](@ref spritebatch_guide): Used to draw efficient 2D sprites and tiles.
+- [Logger](@ref logger_guide): Asynchronous logger.
+
+License
+-------
+
+Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> 
+MIT License, see LICENSE file for more details.
diff --git a/docs/matrix.dox b/docs/matrix.md
index c1c99dde..93138bb9 100644
--- a/docs/matrix.dox
+++ b/docs/matrix.md
@@ -1,6 +1,4 @@
-/** @class yage::Matrix
-
-%Matrix Class
+Matrix Guide {#matrix_guide}
 ============
 
 The matrix class is a templated class which implements a mathematical %Matrix.
@@ -17,7 +15,7 @@ Example Code
 
 Creating a %Matrix and performing operations on it.
 
-```
+``` c++
 #include <YAGE/Math/matrix.hpp>
 
 int main(int, char **)
@@ -29,5 +27,3 @@ int main(int, char **)
     return 0;
 }
 ```
-
-*/
diff --git a/docs/spritebatch.md b/docs/spritebatch.md
new file mode 100644
index 00000000..fc3e9c42
--- /dev/null
+++ b/docs/spritebatch.md
@@ -0,0 +1,3 @@
+Sprite Batching {#spritebatch_guide}
+===============
+
diff --git a/docs/todolist.dox b/docs/todolist.md
index d5035617..f36bd6e5 100644
--- a/docs/todolist.dox
+++ b/docs/todolist.md
@@ -1,24 +1,35 @@
-/** @todo
-# Add comments
+Add Comments
+============
+
+Reason
+------
 
-## Reason
 Currently there are no comments in the code. They should be added so that in the future the code
 can be edited easily and improved without having to know the exact implementation of every function.
 
-## Requirements
+Requirements
+------------
+
 - It should follow the doxygen API so that documentation can easily be generated.
 
-*/
 
-/** @todo
-# Switch GPU API
+Switch GPU API
+==============
+
+Reason
+------
 
-## Reason
 Vulkan is much more straight forward and it should be easier to understand OpenGL from it. I
 also the newest API that will be used in the newest games and is supported by quite a few
 graphics cards.
 
-## Requirements
+Requirements
+------------
+
 - yage shouldn't depend on GL anymore and exclusively use Vulkan libraries.
 
-*/
+Afterthought
+------------
+
+In the end the library will first focus on modern OpenGL, as it is much more concise and easier to
+implement initially.
diff --git a/docs/yage.png b/docs/yage.png
new file mode 100644
index 00000000..8b779433
--- /dev/null
+++ b/docs/yage.png