Built mkdocs

This commit is contained in:
Leonetienne
2021-06-04 02:48:22 +02:00
parent 723c62a124
commit a88bbfe1fa
102 changed files with 467 additions and 320 deletions

View File

@@ -85,25 +85,37 @@ $(function() {
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;{</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;{<span class="comment"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> /** Internal helper class. Feel free to use it tho.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classHazelnp_1_1StringTools.html"> 11</a></span>&#160; <span class="keyword">class </span><a class="code" href="classHazelnp_1_1StringTools.html">StringTools</a></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee">Contains</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> c);</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5">Replace</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> find, <span class="keyword">const</span> std::string&amp; subst);</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5">Replace</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> std::string&amp; find, <span class="keyword">const</span> std::string&amp; subst);</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68">IsNumeric</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">bool</span> allowDecimalPoint = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82">ParseNumber</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keywordtype">bool</span>&amp; out_isInt, <span class="keywordtype">long</span> <span class="keywordtype">double</span>&amp; out_number);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16">SplitString</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> delimiter);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16">SplitString</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> std::string&amp; delimiter);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a67edf755685f59b51f7416d9e4f6e2bd">ToLower</a>(<span class="keyword">const</span> std::string&amp; str);</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> //! Will return wether or not a given char is in a string</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee">Contains</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> c);</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> //! Will replace a part of a string with another string</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"></span> <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5">Replace</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> find, <span class="keyword">const</span> std::string&amp; subst);</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> //! Will replace a part of a string with another string</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span> <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5">Replace</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> std::string&amp; find, <span class="keyword">const</span> std::string&amp; subst);</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> //! Will return true if the given string consists only of digits (including signage)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68">IsNumeric</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">bool</span> allowDecimalPoint = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> //! Will convert the number in str to a number. </span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> //! Returns wether or not the operation was successful. </span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> //! Also returns wether the number is an integer, or floating point. If int, cast out_number to int.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82">ParseNumber</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keywordtype">bool</span>&amp; out_isInt, <span class="keywordtype">long</span> <span class="keywordtype">double</span>&amp; out_number);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> //! Will split a string by a delimiter char. The delimiter will be excluded!</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"></span> <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16">SplitString</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> <span class="keywordtype">char</span> delimiter);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> //! Will split a string by a delimiter string. The delimiter will be excluded!</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16">SplitString</a>(<span class="keyword">const</span> std::string&amp; str, <span class="keyword">const</span> std::string&amp; delimiter);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> //! Will make a string all lower-case</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> <span class="keyword">static</span> std::string <a class="code" href="classHazelnp_1_1StringTools.html#a67edf755685f59b51f7416d9e4f6e2bd">ToLower</a>(<span class="keyword">const</span> std::string&amp; str);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; };</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
@@ -117,7 +129,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1StringTools_html_a67edf755685f59b51f7416d9e4f6e2bd"><div class="ttname"><a href="classHazelnp_1_1StringTools.html#a67edf755685f59b51f7416d9e4f6e2bd">Hazelnp::StringTools::ToLower</a></div><div class="ttdeci">static std::string ToLower(const std::string &amp;str)</div><div class="ttdoc">Will make a string all lower-case.</div><div class="ttdef"><b>Definition:</b> <a href="StringTools_8cpp_source.html#l00173">StringTools.cpp:173</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 4 2021 02:43:55 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Jun 4 2021 02:48:01 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>