[Travis] Rebuilding documentation

1 files changed, 110 insertions, 47 deletions

diff --git a/classyage_1_1Logger.html b/classyage_1_1Logger.html
index 602db2e4..b1f14b1f 100644
--- a/classyage_1_1Logger.html
+++ b/classyage_1_1Logger.html
@@ -109,21 +109,30 @@ $(document).ready(function(){initNavTree('classyage_1_1Logger.html','');});
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
-<a href="#pri-attribs">Private Attributes</a> &#124;
 <a href="classyage_1_1Logger-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">yage::Logger Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">
 
+<p><h2><a class="el" href="classyage_1_1Logger.html" title="Logger">Logger</a></h2>
+ 
+ <a href="classyage_1_1Logger.html#details">More...</a></p>
+
 <p><code>#include &lt;<a class="el" href="logger_8h_source.html">logger.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a950c0c75b86bf330cf11a0ad29bd9a64"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a950c0c75b86bf330cf11a0ad29bd9a64">Logger</a> ()</td></tr>
 <tr class="separator:a950c0c75b86bf330cf11a0ad29bd9a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a541278f8908daecb8d56d6da0a5642b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1LogMessage.html">LogMessage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a541278f8908daecb8d56d6da0a5642b6">operator()</a> (const std::string &amp;fileName, int lineNum)</td></tr>
-<tr class="separator:a541278f8908daecb8d56d6da0a5642b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3d54590303257e9a8d1da26d59571352"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a3d54590303257e9a8d1da26d59571352">Logger</a> (const std::string &amp;file_path)</td></tr>
+<tr class="separator:a3d54590303257e9a8d1da26d59571352"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a71f6ab0fa1e86d790553c0763a255b2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a71f6ab0fa1e86d790553c0763a255b2b">Logger</a> (<a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a> min_level)</td></tr>
+<tr class="separator:a71f6ab0fa1e86d790553c0763a255b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acbd21a2da8b423e9f606c386cabac074"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#acbd21a2da8b423e9f606c386cabac074">Logger</a> (<a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a> min_level, const std::string &amp;file_path)</td></tr>
+<tr class="separator:acbd21a2da8b423e9f606c386cabac074"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3c7d6d1a9ccf0397dc81350cef6782f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1LogMessage.html">LogMessage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a3c7d6d1a9ccf0397dc81350cef6782f2">operator()</a> (<a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a> level=<a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a551b723eafd6a31d444fcb2f5920fbd3">LogLevel::INFO</a>, const std::string &amp;fileName=&quot;&quot;, int lineNum=-1)</td></tr>
+<tr class="separator:a3c7d6d1a9ccf0397dc81350cef6782f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:afe5dc1d30d3fd2599a119455672d6e00"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#afe5dc1d30d3fd2599a119455672d6e00">flush</a> (const <a class="el" href="classyage_1_1LogMessage.html">LogMessage</a> *msg)</td></tr>
 <tr class="separator:afe5dc1d30d3fd2599a119455672d6e00"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5ec9a752e8cbb278342fdb49520fbcdd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a5ec9a752e8cbb278342fdb49520fbcdd">add</a> (const <a class="el" href="classyage_1_1LogSink.html">LogSink</a> &amp;sink)</td></tr>
@@ -132,23 +141,45 @@ Public Member Functions</h2></td></tr>
 <tr class="separator:aac48688c66402e9bc63c4871641ab245"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a036fcbfcb9d3428931ec5a11237501a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a036fcbfcb9d3428931ec5a11237501a8">clear</a> ()</td></tr>
 <tr class="separator:a036fcbfcb9d3428931ec5a11237501a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2ce5eb7eb1b108e38c1b90655999a8eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a2ce5eb7eb1b108e38c1b90655999a8eb">setLevel</a> (<a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a> min_level)</td></tr>
+<tr class="separator:a2ce5eb7eb1b108e38c1b90655999a8eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:ad165738c5b738d80a14b0ee1319cae2e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classyage_1_1Logger.html">Logger</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#ad165738c5b738d80a14b0ee1319cae2e">instance</a> ()</td></tr>
 <tr class="separator:ad165738c5b738d80a14b0ee1319cae2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
-Private Attributes</h2></td></tr>
-<tr class="memitem:a4135a0742877aa36d52f1867bc4e7b1f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classyage_1_1LogSink.html">LogSink</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a4135a0742877aa36d52f1867bc4e7b1f">sinks_</a></td></tr>
-<tr class="separator:a4135a0742877aa36d52f1867bc4e7b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a489f97b1b21ac425ebbdb063de068744"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classyage_1_1Active.html">Active</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html#a489f97b1b21ac425ebbdb063de068744">active_</a></td></tr>
-<tr class="separator:a489f97b1b21ac425ebbdb063de068744"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><h2><a class="el" href="classyage_1_1Logger.html" title="Logger">Logger</a></h2>
+<p>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.</p>
+<h3>Log levels</h3>
+<p>The logger has five different levels that can be assigned to a message. These are, from lowest to highest severity, <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788adc30ec20708ef7b0f641ef78b7880a15">LogLevel::DEBUG</a></code>, <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a551b723eafd6a31d444fcb2f5920fbd3">LogLevel::INFO</a></code>, <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a059e9861e0400dfbe05c98a841f3f96b">LogLevel::WARNING</a></code>, <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788abb1ca97ec761fc37101737ba0aa2e7c5">LogLevel::ERROR</a></code> and <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a19da7170bea36556dde582519795f3fc">LogLevel::FATAL</a></code>. 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 <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a551b723eafd6a31d444fcb2f5920fbd3">LogLevel::INFO</a></code>.</p>
+<h3>Using the <a class="el" href="classyage_1_1Logger.html" title="Logger">Logger</a> in your Game</h3>
+<p>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 can then be used to set a different minimum display level. This definition is <code>yLogger</code>, and an example of how to use it to change the default output level can be seen below</p>
+<p>``` c++ yLogger.setLevel(yage::LogLevel::ERROR); ```</p>
+<p>The above code changes the global logger so that it will only output things that are an error or fatal and make the engine crash.</p>
+<p>Other preprocessor definitions are <code>yLogDebug</code>, <code>yLogInfo</code>, <code>yLogWarning</code>, <code>yLogError</code> and <code>yLogFatal</code>. These return an object that is similar to a buffer, but belongs to the main global logger <code>yLogger</code>. These are the definitions that should be used to print somehting to the main logger. For example</p>
+<p>``` c++ yLogWarning &lt;&lt; "This is a warning"; ```</p>
+<p>will print the message "This is a warning" with the severity of <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a059e9861e0400dfbe05c98a841f3f96b">LogLevel::WARNING</a></code>. </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a950c0c75b86bf330cf11a0ad29bd9a64"></a>
 <div class="memitem">
 <div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">yage::Logger::Logger </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a class="anchor" id="a3d54590303257e9a8d1da26d59571352"></a>
+<div class="memitem">
+<div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
@@ -156,7 +187,32 @@ Private Attributes</h2></td></tr>
         <tr>
           <td class="memname">yage::Logger::Logger </td>
           <td>(</td>
-          <td class="paramname"></td><td>)</td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>file_path</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a class="anchor" id="a71f6ab0fa1e86d790553c0763a255b2b"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">yage::Logger::Logger </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a>&#160;</td>
+          <td class="paramname"><em>min_level</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
@@ -169,6 +225,32 @@ Private Attributes</h2></td></tr>
 
 </div>
 </div>
+<a class="anchor" id="acbd21a2da8b423e9f606c386cabac074"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">yage::Logger::Logger </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a>&#160;</td>
+          <td class="paramname"><em>min_level</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>file_path</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="a5ec9a752e8cbb278342fdb49520fbcdd"></a>
 <div class="memitem">
@@ -240,21 +322,27 @@ Private Attributes</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a541278f8908daecb8d56d6da0a5642b6"></a>
+<a class="anchor" id="a3c7d6d1a9ccf0397dc81350cef6782f2"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="classyage_1_1LogMessage.html">LogMessage</a> yage::Logger::operator() </td>
           <td>(</td>
+          <td class="paramtype"><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a>&#160;</td>
+          <td class="paramname"><em>level</em> = <code><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a551b723eafd6a31d444fcb2f5920fbd3">LogLevel::INFO</a></code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
           <td class="paramtype">const std::string &amp;&#160;</td>
-          <td class="paramname"><em>fileName</em>, </td>
+          <td class="paramname"><em>fileName</em> = <code>&quot;&quot;</code>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&#160;</td>
-          <td class="paramname"><em>lineNum</em>&#160;</td>
+          <td class="paramname"><em>lineNum</em> = <code>-1</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -282,43 +370,18 @@ Private Attributes</h2></td></tr>
 
 </div>
 </div>
-<h2 class="groupheader">Member Data Documentation</h2>
-<a class="anchor" id="a489f97b1b21ac425ebbdb063de068744"></a>
+<a class="anchor" id="a2ce5eb7eb1b108e38c1b90655999a8eb"></a>
 <div class="memitem">
 <div class="memproto">
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">std::unique_ptr&lt;<a class="el" href="classyage_1_1Active.html">Active</a>&gt; yage::Logger::active_</td>
-        </tr>
-      </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">private</span></span>  </td>
-  </tr>
-</table>
-</div><div class="memdoc">
-
-</div>
-</div>
-<a class="anchor" id="a4135a0742877aa36d52f1867bc4e7b1f"></a>
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
-      <table class="memname">
-        <tr>
-          <td class="memname">std::vector&lt;<a class="el" href="classyage_1_1LogSink.html">LogSink</a>&gt; yage::Logger::sinks_</td>
+          <td class="memname">void yage::Logger::setLevel </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">LogLevel</a>&#160;</td>
+          <td class="paramname"><em>min_level</em></td><td>)</td>
+          <td></td>
         </tr>
       </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">private</span></span>  </td>
-  </tr>
-</table>
 </div><div class="memdoc">
 
 </div>
@@ -333,7 +396,7 @@ Private Attributes</h2></td></tr>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="namespaceyage.html">yage</a></li><li class="navelem"><a class="el" href="classyage_1_1Logger.html">Logger</a></li>
-    <li class="footer">Generated on Sat Dec 23 2017 01:50:21 for YAGE by
+    <li class="footer">Generated on Sat Jan 6 2018 11:36:17 for YAGE by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
   </ul>