Doxygen doc cleanup (excluding external libs) + gh pages update

Author: SSBMTonberry

README.md

@@ -11,6 +11,13 @@ maps made with newer versions of Tiled just as well.
 
 Be sure to take a look at the release notes to see what's new!
 
+https://ssbmtonberry.github.io/tileson/html
+
+## Documentation
+
+There is a `Doxygen` generated documentation of Tileson that can be found [HERE](https://ssbmtonberry.github.io/tileson/html)
+
+
 # Tileson is header-only!
 This means that all you need is one file, `single_include/tileson.hpp` to have Tileson going
 in your project! The single-file is generated, and is quite large, as it uses the nlohmann/json as a built-in dependency,

docs/Doxyfile

@@ -913,7 +913,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       =
+EXCLUDE_PATTERNS       = */external/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

docs/html/Chunk_8hpp_source.html

@@ -87,9 +87,9 @@
 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;        <span class="keyword">public</span>:</div>
 <div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">   15</a></span>&#160;            <span class="keyword">inline</span> <a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">Frame</a>() = <span class="keywordflow">default</span>;</div>
 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;            <span class="keyword">inline</span> <a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">Frame</a>(<span class="keywordtype">int</span> duration, <span class="keywordtype">int</span> tileId);</div>
-<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;            <span class="keyword">inline</span> <a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">Frame</a>(<span class="keyword">const</span> <a class="code" href="classnlohmann_1_1basic__json.html">nlohmann::json</a> &amp;<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>);</div>
+<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;            <span class="keyword">inline</span> <a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">Frame</a>(<span class="keyword">const</span> nlohmann::json &amp;json);</div>
 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
-<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;            <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">parse</a>(<span class="keyword">const</span> <a class="code" href="classnlohmann_1_1basic__json.html">nlohmann::json</a> &amp;<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>);</div>
+<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;            <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">parse</a>(<span class="keyword">const</span> nlohmann::json &amp;json);</div>
 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;            [[nodiscard]] <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classtson_1_1Frame.html#a64d0428ca6c866bc3cd6d21b76400653">getDuration</a>() <span class="keyword">const</span>;</div>
 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;            [[nodiscard]] <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classtson_1_1Frame.html#ad6b12577aafb1daeea6e991703a3ea2e">getTileId</a>() <span class="keyword">const</span>;</div>
@@ -105,17 +105,17 @@
 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160; </div>
 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;}</div>
 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
-<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classtson_1_1Frame.html#a57364e4580faa6246c419b015e694c97">   44</a></span>&#160;<a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">tson::Frame::Frame</a>(<span class="keyword">const</span> <a class="code" href="classnlohmann_1_1basic__json.html">nlohmann::json</a> &amp;<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>)</div>
+<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classtson_1_1Frame.html#a57364e4580faa6246c419b015e694c97">   44</a></span>&#160;<a class="code" href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">tson::Frame::Frame</a>(<span class="keyword">const</span> nlohmann::json &amp;json)</div>
 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;{</div>
-<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="namespacepicojson.html#a3aca598f5855bc130a92a3e08a0c6ebf">parse</a>(<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>);</div>
+<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    parse(json);</div>
 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;}</div>
 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
-<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">   54</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">tson::Frame::parse</a>(<span class="keyword">const</span> <a class="code" href="classnlohmann_1_1basic__json.html">nlohmann::json</a> &amp;<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>)</div>
+<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">   54</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">tson::Frame::parse</a>(<span class="keyword">const</span> nlohmann::json &amp;json)</div>
 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;{</div>
 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">bool</span> allFound = <span class="keyword">true</span>;</div>
 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160; </div>
-<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keywordflow">if</span>(<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>.count(<span class="stringliteral">&quot;duration&quot;</span>) &gt; 0) m_duration = <a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>[<span class="stringliteral">&quot;duration&quot;</span>].get&lt;<span class="keywordtype">int</span>&gt;(); <span class="keywordflow">else</span> allFound = <span class="keyword">false</span>;</div>
-<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordflow">if</span>(<a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>.count(<span class="stringliteral">&quot;tileid&quot;</span>) &gt; 0) m_tileId = <a class="code" href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">json</a>[<span class="stringliteral">&quot;tileid&quot;</span>].get&lt;int&gt;(); <span class="keywordflow">else</span> allFound = <span class="keyword">false</span>;</div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keywordflow">if</span>(json.count(<span class="stringliteral">&quot;duration&quot;</span>) &gt; 0) m_duration = json[<span class="stringliteral">&quot;duration&quot;</span>].get&lt;<span class="keywordtype">int</span>&gt;(); <span class="keywordflow">else</span> allFound = <span class="keyword">false</span>;</div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordflow">if</span>(json.count(<span class="stringliteral">&quot;tileid&quot;</span>) &gt; 0) m_tileId = json[<span class="stringliteral">&quot;tileid&quot;</span>].get&lt;int&gt;(); <span class="keywordflow">else</span> allFound = <span class="keyword">false</span>;</div>
 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160; </div>
 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordflow">return</span> allFound;</div>
 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;}</div>
@@ -133,10 +133,7 @@
 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#endif //TILESON_FRAME_HPP</span></div>
 </div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="aclasstson_1_1Frame_html"><div class="ttname"><a href="classtson_1_1Frame.html">tson::Frame</a></div><div class="ttdef"><b>Definition:</b> Frame.hpp:13</div></div>
-<div class="ttc" id="anamespacenlohmann_html_a2bfd99e845a2e5cd90aeaf1b1431f474"><div class="ttname"><a href="namespacenlohmann.html#a2bfd99e845a2e5cd90aeaf1b1431f474">nlohmann::json</a></div><div class="ttdeci">basic_json&lt;&gt; json</div><div class="ttdoc">default JSON class</div><div class="ttdef"><b>Definition:</b> json.hpp:2355</div></div>
 <div class="ttc" id="aclasstson_1_1Frame_html_a64d0428ca6c866bc3cd6d21b76400653"><div class="ttname"><a href="classtson_1_1Frame.html#a64d0428ca6c866bc3cd6d21b76400653">tson::Frame::getDuration</a></div><div class="ttdeci">int getDuration() const</div><div class="ttdef"><b>Definition:</b> Frame.hpp:68</div></div>
-<div class="ttc" id="anamespacepicojson_html_a3aca598f5855bc130a92a3e08a0c6ebf"><div class="ttname"><a href="namespacepicojson.html#a3aca598f5855bc130a92a3e08a0c6ebf">picojson::parse</a></div><div class="ttdeci">std::string parse(value &amp;out, Iter &amp;pos, const Iter &amp;last)</div><div class="ttdef"><b>Definition:</b> picojson.hpp:1073</div></div>
-<div class="ttc" id="aclassnlohmann_1_1basic__json_html"><div class="ttname"><a href="classnlohmann_1_1basic__json.html">nlohmann::basic_json</a></div><div class="ttdoc">a class to store JSON values</div><div class="ttdef"><b>Definition:</b> json.hpp:14572</div></div>
 <div class="ttc" id="aclasstson_1_1Frame_html_ad9ca20e025d3370501a64a2f7ef0b5e0"><div class="ttname"><a href="classtson_1_1Frame.html#ad9ca20e025d3370501a64a2f7ef0b5e0">tson::Frame::Frame</a></div><div class="ttdeci">Frame()=default</div></div>
 <div class="ttc" id="aclasstson_1_1Frame_html_ad6b12577aafb1daeea6e991703a3ea2e"><div class="ttname"><a href="classtson_1_1Frame.html#ad6b12577aafb1daeea6e991703a3ea2e">tson::Frame::getTileId</a></div><div class="ttdeci">int getTileId() const</div><div class="ttdef"><b>Definition:</b> Frame.hpp:77</div></div>
 <div class="ttc" id="aclasstson_1_1Frame_html_ac4b0f3e568c2d3b62a6e8ac1b975bb2e"><div class="ttname"><a href="classtson_1_1Frame.html#ac4b0f3e568c2d3b62a6e8ac1b975bb2e">tson::Frame::parse</a></div><div class="ttdeci">bool parse(const nlohmann::json &amp;json)</div><div class="ttdef"><b>Definition:</b> Frame.hpp:54</div></div>