leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Built doxygen

Browse Source
This commit is contained in:
Leonetienne
2021-08-04 21:17:44 +02:00
parent 2a61fa980a
commit 20bb720c6e
175 changed files with 1251 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/CmdArgsInterface_8cpp_source.html
View File

@@ -323,7 +323,7 @@ $(function() {
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="keyword">const</span> std::string&amp; val = values[0];</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; </div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; <span class="comment">// String</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68">StringTools::IsNumeric</a>(val, <span class="keyword">true</span>))</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Internal_1_1StringTools.html#a1abf1454a223165acfb52f2a246c8215">Internal::StringTools::IsNumeric</a>(val, <span class="keyword">true</span>))</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; {</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; rawInputType = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa63b588d5559f64f89a416e656880b949">DATA_TYPE::STRING</a>;</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; </div>
@@ -365,7 +365,7 @@ $(function() {
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; <span class="keywordtype">bool</span> isInt;</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; <span class="keywordtype">long</span> <span class="keywordtype">double</span> num;</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; </div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82">StringTools::ParseNumber</a>(val, isInt, num))</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classHazelnp_1_1Internal_1_1StringTools.html#a3cc71bfffcad9a4334e74aac69dbfd68">Internal::StringTools::ParseNumber</a>(val, isInt, num))</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; {</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; rawInputType = isInt ? <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92">DATA_TYPE::INT</a> : <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fae738c26bf4ce1037fa81b039a915cbf6">DATA_TYPE::FLOAT</a>;</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; </div>
@@ -708,9 +708,7 @@ $(function() {
<div class="ttc" id="aHazelnuppException_8h_html"><div class="ttname"><a href="HazelnuppException_8h.html">HazelnuppException.h</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8h_source.html#l00007">CmdArgsInterface.h:7</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1IntValue_html"><div class="ttname"><a href="classHazelnp_1_1IntValue.html">Hazelnp::IntValue</a></div><div class="ttdoc">Specializations for integer values (uses long long int)</div><div class="ttdef"><b>Definition:</b> <a href="IntValue_8h_source.html#l00008">IntValue.h:8</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1StringTools_html_a6cd093feaca2d978c23774cf87d86e68"><div class="ttname"><a href="classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68">Hazelnp::StringTools::IsNumeric</a></div><div class="ttdeci">static bool IsNumeric(const std::string &amp;str, const bool allowDecimalPoint=false)</div><div class="ttdoc">Will return true if the given string consists only of digits (including signage)</div><div class="ttdef"><b>Definition:</b> <a href="StringTools_8cpp_source.html#l00056">StringTools.cpp:56</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_adec82884377a5193f68dcc7b6ef69d8b"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#adec82884377a5193f68dcc7b6ef69d8b">Hazelnp::CmdArgsInterface::GetConstraint</a></div><div class="ttdeci">ParamConstraint GetConstraint(const std::string &amp;parameter) const</div><div class="ttdoc">Will return the constraint information for a specific parameter.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00542">CmdArgsInterface.cpp:542</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1StringTools_html_ab661223da5bbbb75039e168409466c82"><div class="ttname"><a href="classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82">Hazelnp::StringTools::ParseNumber</a></div><div class="ttdeci">static bool ParseNumber(const std::string &amp;str, bool &amp;out_isInt, long double &amp;out_number)</div><div class="ttdoc">Will convert the number in str to a number.</div><div class="ttdef"><b>Definition:</b> <a href="StringTools_8cpp_source.html#l00082">StringTools.cpp:82</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a019e48f48427e7caa76c964bd0f117d0"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a019e48f48427e7caa76c964bd0f117d0">Hazelnp::CmdArgsInterface::ClearAbbreviations</a></div><div class="ttdeci">void ClearAbbreviations()</div><div class="ttdoc">Will delete all abbreviations.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00592">CmdArgsInterface.cpp:592</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_abf553ed4acabf9e1db357715bc10533c"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#abf553ed4acabf9e1db357715bc10533c">Hazelnp::CmdArgsInterface::SetCatchHelp</a></div><div class="ttdeci">void SetCatchHelp(bool catchHelp)</div><div class="ttdoc">Sets whether the CmdArgsInterface should automatically catch the –help parameter, print the parameter...</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00334">CmdArgsInterface.cpp:334</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a58b81709e631cee5f3db3f3f48611fe9"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9">Hazelnp::CmdArgsInterface::HasAbbreviation</a></div><div class="ttdeci">bool HasAbbreviation(const std::string &amp;abbrev) const</div><div class="ttdoc">Will check wether or not an abbreviation is registered.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00581">CmdArgsInterface.cpp:581</a></div></div>
@@ -753,6 +751,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1VoidValue_html"><div class="ttname"><a href="classHazelnp_1_1VoidValue.html">Hazelnp::VoidValue</a></div><div class="ttdoc">Specializations for void values.</div><div class="ttdef"><b>Definition:</b> <a href="VoidValue_8h_source.html#l00008">VoidValue.h:8</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a9b9bc5c4443799ea847077e9cefb1927"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927">Hazelnp::CmdArgsInterface::GenerateDocumentation</a></div><div class="ttdeci">std::string GenerateDocumentation() const</div><div class="ttdoc">Will generate a text-based documentation suited to show the user, for example on –help.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00391">CmdArgsInterface.cpp:391</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a6589d2e818ba32f2a3e5b5a6a5e2bf1e"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a6589d2e818ba32f2a3e5b5a6a5e2bf1e">Hazelnp::CmdArgsInterface::RegisterDescription</a></div><div class="ttdeci">void RegisterDescription(const std::string &amp;parameter, const std::string &amp;description)</div><div class="ttdoc">Willl register a short description for a parameter.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00356">CmdArgsInterface.cpp:356</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Internal_1_1StringTools_html_a3cc71bfffcad9a4334e74aac69dbfd68"><div class="ttname"><a href="classHazelnp_1_1Internal_1_1StringTools.html#a3cc71bfffcad9a4334e74aac69dbfd68">Hazelnp::Internal::StringTools::ParseNumber</a></div><div class="ttdeci">static bool ParseNumber(const std::string &amp;str, bool &amp;out_isInt, long double &amp;out_number)</div><div class="ttdoc">Will convert the number in str to a number.</div><div class="ttdef"><b>Definition:</b> <a href="StringTools_8cpp_source.html#l00082">StringTools.cpp:82</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fae738c26bf4ce1037fa81b039a915cbf6"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fae738c26bf4ce1037fa81b039a915cbf6">Hazelnp::DATA_TYPE::FLOAT</a></div><div class="ttdeci">@ FLOAT</div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a89bc3f54d7ff0740549dbdf7b7f727e3"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a89bc3f54d7ff0740549dbdf7b7f727e3">Hazelnp::CmdArgsInterface::GetDescription</a></div><div class="ttdeci">const std::string &amp; GetDescription(const std::string &amp;parameter) const</div><div class="ttdoc">Will return a short description for a parameter, if it exists.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00362">CmdArgsInterface.cpp:362</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92">Hazelnp::DATA_TYPE::INT</a></div><div class="ttdeci">@ INT</div></div>
@@ -762,6 +761,7 @@ $(function() {
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa63b588d5559f64f89a416e656880b949"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa63b588d5559f64f89a416e656880b949">Hazelnp::DATA_TYPE::STRING</a></div><div class="ttdeci">@ STRING</div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_afe83a815b21d37b3d2a6d0ef67137faf"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#afe83a815b21d37b3d2a6d0ef67137faf">Hazelnp::CmdArgsInterface::GetExecutableName</a></div><div class="ttdeci">const std::string &amp; GetExecutableName() const</div><div class="ttdoc">Will return argv[0], the name of the executable.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00553">CmdArgsInterface.cpp:553</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html_a7fb1e5ad9e2ecb6c0025beb19f11621b"><div class="ttname"><a href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">Hazelnp::DataTypeToString</a></div><div class="ttdeci">static std::string DataTypeToString(DATA_TYPE type)</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00017">DataType.h:17</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Internal_1_1StringTools_html_a1abf1454a223165acfb52f2a246c8215"><div class="ttname"><a href="classHazelnp_1_1Internal_1_1StringTools.html#a1abf1454a223165acfb52f2a246c8215">Hazelnp::Internal::StringTools::IsNumeric</a></div><div class="ttdeci">static bool IsNumeric(const std::string &amp;str, const bool allowDecimalPoint=false)</div><div class="ttdoc">Will return true if the given string consists only of digits (including signage)</div><div class="ttdef"><b>Definition:</b> <a href="StringTools_8cpp_source.html#l00056">StringTools.cpp:56</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a16a3a02f77d240d8cf51cd4ee1797113"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a16a3a02f77d240d8cf51cd4ee1797113">Hazelnp::CmdArgsInterface::SetCrashOnFail</a></div><div class="ttdeci">void SetCrashOnFail(bool crashOnFail)</div><div class="ttdoc">Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00611">CmdArgsInterface.cpp:611</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html"><div class="ttname"><a href="classHazelnp_1_1ListValue.html">Hazelnp::ListValue</a></div><div class="ttdoc">Specializations for list values (uses std::vector&lt;Value*&gt;)</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8h_source.html#l00009">ListValue.h:9</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1StringValue_html"><div class="ttname"><a href="classHazelnp_1_1StringValue.html">Hazelnp::StringValue</a></div><div class="ttdoc">Specializations for string values (uses std::string)</div><div class="ttdef"><b>Definition:</b> <a href="StringValue_8h_source.html#l00009">StringValue.h:9</a></div></div>
@@ -769,7 +769,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_aadc75b3b6c9662cfbd4a936468d50466"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#aadc75b3b6c9662cfbd4a936468d50466">Hazelnp::CmdArgsInterface::~CmdArgsInterface</a></div><div class="ttdeci">~CmdArgsInterface()</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00026">CmdArgsInterface.cpp:26</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 8 2021 14:02:39 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Aug 4 2021 21:16:24 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>