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

Built mkdocs

Browse Source
This commit is contained in:
Leonetienne
2021-06-06 15:32:19 +02:00
parent 6166e43d31
commit 78e7f14b22
200 changed files with 1662 additions and 1472 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/Hazelnupp_8h_source.html
View File

@@ -226,42 +226,42 @@ $(function() {
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00004">DataType.h:4</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1d32c3047a8c58650476d1ae7e9fb582"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1d32c3047a8c58650476d1ae7e9fb582">Hazelnp::Hazelnupp::GetBriefDescription</a></div><div class="ttdeci">const std::string &amp; GetBriefDescription()</div><div class="ttdoc">Returns the brief description of the application to be automatically added to the documentation.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00319">Hazelnupp.cpp:319</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a3970b74583def49c6632fe08a4499809"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a3970b74583def49c6632fe08a4499809">Hazelnp::Hazelnupp::ClearConstraints</a></div><div class="ttdeci">void ClearConstraints()</div><div class="ttdoc">Will delete all constraints.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00565">Hazelnupp.cpp:565</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_af6bb41fb079131f8b91fe981f63f7469"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#af6bb41fb079131f8b91fe981f63f7469">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00513">Hazelnupp.cpp:513</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a7b1bf5e700d8a0d8e90c5750e54749de"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00359">Hazelnupp.cpp:359</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_acaec2780d800113ffc2d72a6b865955c"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#acaec2780d800113ffc2d72a6b865955c">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00502">Hazelnupp.cpp:502</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1d32c3047a8c58650476d1ae7e9fb582"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1d32c3047a8c58650476d1ae7e9fb582">Hazelnp::Hazelnupp::GetBriefDescription</a></div><div class="ttdeci">const std::string &amp; GetBriefDescription()</div><div class="ttdoc">Returns the brief description of the application to be automatically added to the documentation.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00351">Hazelnupp.cpp:351</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a3970b74583def49c6632fe08a4499809"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a3970b74583def49c6632fe08a4499809">Hazelnp::Hazelnupp::ClearConstraints</a></div><div class="ttdeci">void ClearConstraints()</div><div class="ttdoc">Will delete all constraints.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00605">Hazelnupp.cpp:605</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_af6bb41fb079131f8b91fe981f63f7469"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#af6bb41fb079131f8b91fe981f63f7469">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00553">Hazelnupp.cpp:553</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a7b1bf5e700d8a0d8e90c5750e54749de"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00391">Hazelnupp.cpp:391</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_acaec2780d800113ffc2d72a6b865955c"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#acaec2780d800113ffc2d72a6b865955c">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00542">Hazelnupp.cpp:542</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a25f8810d24d647b6a57e2dd00ead42be"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a25f8810d24d647b6a57e2dd00ead42be">Hazelnp::Hazelnupp::~Hazelnupp</a></div><div class="ttdeci">~Hazelnupp()</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00026">Hazelnupp.cpp:26</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a419ccdc6bad00b0fc3e17ed9b41f5dc5"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5">Hazelnp::Hazelnupp::operator[]</a></div><div class="ttdeci">const Value &amp; operator[](const std::string &amp;key) const</div><div class="ttdoc">Will return the value given a key.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00518">Hazelnupp.cpp:518</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a419ccdc6bad00b0fc3e17ed9b41f5dc5"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5">Hazelnp::Hazelnupp::operator[]</a></div><div class="ttdeci">const Value &amp; operator[](const std::string &amp;key) const</div><div class="ttdoc">Will return the value given a key.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00558">Hazelnupp.cpp:558</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html">Hazelnp::Hazelnupp</a></div><div class="ttdoc">The main class to interface with.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8h_source.html#l00011">Hazelnupp.h:11</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a20ac0ebcfd4df7f320a7bbcaeed6e54d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a20ac0ebcfd4df7f320a7bbcaeed6e54d">Hazelnp::Hazelnupp::Hazelnupp</a></div><div class="ttdeci">Hazelnupp()</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00015">Hazelnupp.cpp:15</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a5175869b025468324cefad487081e91d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a5175869b025468324cefad487081e91d">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00552">Hazelnupp.cpp:552</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a037f84b32c7a2420c387dd46445291ac"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a037f84b32c7a2420c387dd46445291ac">Hazelnp::Hazelnupp::SetBriefDescription</a></div><div class="ttdeci">void SetBriefDescription(const std::string &amp;description)</div><div class="ttdoc">Sets a brief description of the application to be automatically added to the documentation.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00313">Hazelnupp.cpp:313</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a5175869b025468324cefad487081e91d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a5175869b025468324cefad487081e91d">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00592">Hazelnupp.cpp:592</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a037f84b32c7a2420c387dd46445291ac"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a037f84b32c7a2420c387dd46445291ac">Hazelnp::Hazelnupp::SetBriefDescription</a></div><div class="ttdeci">void SetBriefDescription(const std::string &amp;description)</div><div class="ttdoc">Sets a brief description of the application to be automatically added to the documentation.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00345">Hazelnupp.cpp:345</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Value_html"><div class="ttname"><a href="classHazelnp_1_1Value.html">Hazelnp::Value</a></div><div class="ttdoc">Abstract class for values.</div><div class="ttdef"><b>Definition:</b> <a href="Value_8h_source.html#l00010">Value.h:10</a></div></div>
<div class="ttc" id="aParamConstraint_8h_html"><div class="ttname"><a href="ParamConstraint_8h.html">ParamConstraint.h</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1b810cc7db2cf64aecaa70c686b14bb7"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7">Hazelnp::Hazelnupp::GetCrashOnFail</a></div><div class="ttdeci">bool GetCrashOnFail() const</div><div class="ttdoc">Gets whether the application crashes on an exception whilst parsing, and prints to stderr.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00297">Hazelnupp.cpp:297</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_aabab94412ff5eecf95b97a4e21eb9cf6"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#aabab94412ff5eecf95b97a4e21eb9cf6">Hazelnp::Hazelnupp::HasDescription</a></div><div class="ttdeci">bool HasDescription(const std::string &amp;parameter) const</div><div class="ttdoc">Returns whether or not a given parameter has a registered description.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00341">Hazelnupp.cpp:341</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a60e0a51cd92014a87e44322158e45872"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a60e0a51cd92014a87e44322158e45872">Hazelnp::Hazelnupp::SetCatchHelp</a></div><div class="ttdeci">void SetCatchHelp(bool catchHelp)</div><div class="ttdoc">Sets whether the Hazelnupp should automatically catch the –help parameter, print the parameter docume...</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00302">Hazelnupp.cpp:302</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a05a3d112bcc00cdeade76f3643ba9e94"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a05a3d112bcc00cdeade76f3643ba9e94">Hazelnp::Hazelnupp::GetCatchHelp</a></div><div class="ttdeci">bool GetCatchHelp() const</div><div class="ttdoc">Retruns whether the Hazelnupp should automatically catch the –help parameter, print the parameter doc...</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00308">Hazelnupp.cpp:308</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1b810cc7db2cf64aecaa70c686b14bb7"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7">Hazelnp::Hazelnupp::GetCrashOnFail</a></div><div class="ttdeci">bool GetCrashOnFail() const</div><div class="ttdoc">Gets whether the application crashes on an exception whilst parsing, and prints to stderr.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00329">Hazelnupp.cpp:329</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_aabab94412ff5eecf95b97a4e21eb9cf6"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#aabab94412ff5eecf95b97a4e21eb9cf6">Hazelnp::Hazelnupp::HasDescription</a></div><div class="ttdeci">bool HasDescription(const std::string &amp;parameter) const</div><div class="ttdoc">Returns whether or not a given parameter has a registered description.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00373">Hazelnupp.cpp:373</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a60e0a51cd92014a87e44322158e45872"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a60e0a51cd92014a87e44322158e45872">Hazelnp::Hazelnupp::SetCatchHelp</a></div><div class="ttdeci">void SetCatchHelp(bool catchHelp)</div><div class="ttdoc">Sets whether the Hazelnupp should automatically catch the –help parameter, print the parameter docume...</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00334">Hazelnupp.cpp:334</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a05a3d112bcc00cdeade76f3643ba9e94"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a05a3d112bcc00cdeade76f3643ba9e94">Hazelnp::Hazelnupp::GetCatchHelp</a></div><div class="ttdeci">bool GetCatchHelp() const</div><div class="ttdoc">Retruns whether the Hazelnupp should automatically catch the –help parameter, print the parameter doc...</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00340">Hazelnupp.cpp:340</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Parameter_html"><div class="ttname"><a href="classHazelnp_1_1Parameter.html">Hazelnp::Parameter</a></div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8h_source.html#l00008">Parameter.h:8</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html">Hazelnp::ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00008">ParamConstraint.h:8</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a8b79a79d40420ae748c108c691111040"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">Hazelnp::Hazelnupp::HasParam</a></div><div class="ttdeci">bool HasParam(const std::string &amp;key) const</div><div class="ttdoc">Will check wether a parameter exists given a key, or not.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00165">Hazelnupp.cpp:165</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a1ccb88faca1a8deb77161888479c300b"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b">Hazelnp::Hazelnupp::Parse</a></div><div class="ttdeci">void Parse(const int argc, const char *const *argv)</div><div class="ttdoc">Will parse command line arguments.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00036">Hazelnupp.cpp:36</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a26eaac65949072b659531444d32c4cbf"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a26eaac65949072b659531444d32c4cbf">Hazelnp::Hazelnupp::ClearDescription</a></div><div class="ttdeci">void ClearDescription(const std::string &amp;parameter)</div><div class="ttdoc">Will delete the description of a parameter if it exists.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00346">Hazelnupp.cpp:346</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_abf1e0ebf0207ca2327fcde81f7372124"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">Hazelnp::Hazelnupp::RegisterAbbreviation</a></div><div class="ttdeci">void RegisterAbbreviation(const std::string &amp;abbrev, const std::string &amp;target)</div><div class="ttdoc">Will register an abbreviation (like -f for –force)</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00527">Hazelnupp.cpp:527</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a579e78129f19cb9f17a6075366ababe5"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a579e78129f19cb9f17a6075366ababe5">Hazelnp::Hazelnupp::GetAbbreviation</a></div><div class="ttdeci">const std::string &amp; GetAbbreviation(const std::string &amp;abbrev) const</div><div class="ttdoc">Will return the long form of an abbreviation (like –force for -f) Returns &quot;&quot; if no match is found.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00533">Hazelnupp.cpp:533</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_ae266cfb3526b9223fc05beb01646fb42"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#ae266cfb3526b9223fc05beb01646fb42">Hazelnp::Hazelnupp::ClearDescriptions</a></div><div class="ttdeci">void ClearDescriptions()</div><div class="ttdoc">Will delete all parameter descriptions.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00353">Hazelnupp.cpp:353</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a26eaac65949072b659531444d32c4cbf"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a26eaac65949072b659531444d32c4cbf">Hazelnp::Hazelnupp::ClearDescription</a></div><div class="ttdeci">void ClearDescription(const std::string &amp;parameter)</div><div class="ttdoc">Will delete the description of a parameter if it exists.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00378">Hazelnupp.cpp:378</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_abf1e0ebf0207ca2327fcde81f7372124"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124">Hazelnp::Hazelnupp::RegisterAbbreviation</a></div><div class="ttdeci">void RegisterAbbreviation(const std::string &amp;abbrev, const std::string &amp;target)</div><div class="ttdoc">Will register an abbreviation (like -f for –force)</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00567">Hazelnupp.cpp:567</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a579e78129f19cb9f17a6075366ababe5"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a579e78129f19cb9f17a6075366ababe5">Hazelnp::Hazelnupp::GetAbbreviation</a></div><div class="ttdeci">const std::string &amp; GetAbbreviation(const std::string &amp;abbrev) const</div><div class="ttdoc">Will return the long form of an abbreviation (like –force for -f) Returns &quot;&quot; if no match is found.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00573">Hazelnupp.cpp:573</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_ae266cfb3526b9223fc05beb01646fb42"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#ae266cfb3526b9223fc05beb01646fb42">Hazelnp::Hazelnupp::ClearDescriptions</a></div><div class="ttdeci">void ClearDescriptions()</div><div class="ttdoc">Will delete all parameter descriptions.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00385">Hazelnupp.cpp:385</a></div></div>
<div class="ttc" id="aParameter_8h_html"><div class="ttname"><a href="Parameter_8h.html">Parameter.h</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_add731b65fb0741e4fb0b8fc8a601a11d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">Hazelnp::Hazelnupp::RegisterConstraint</a></div><div class="ttdeci">void RegisterConstraint(const std::string &amp;key, const ParamConstraint &amp;constraint)</div><div class="ttdoc">Will register a constraint for a parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00558">Hazelnupp.cpp:558</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a300e55438cb0983b02347fdc3653e32c"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a300e55438cb0983b02347fdc3653e32c">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00330">Hazelnupp.cpp:330</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a63d6bdfc0d6255b5d663f3a786077eb4"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a63d6bdfc0d6255b5d663f3a786077eb4">Hazelnp::Hazelnupp::ClearConstraint</a></div><div class="ttdeci">void ClearConstraint(const std::string &amp;parameter)</div><div class="ttdoc">Will the constraint of a specific parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00507">Hazelnupp.cpp:507</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a46df7d396fb56e30351c9a7308792200"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00541">Hazelnupp.cpp:541</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a17845623ca686caa51f3c8254e85551e"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a17845623ca686caa51f3c8254e85551e">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00571">Hazelnupp.cpp:571</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a17883db87e97caad4a0f114f9f850f5e"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a17883db87e97caad4a0f114f9f850f5e">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00324">Hazelnupp.cpp:324</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a05d1decbb08d1f9368bc9a0d3dfd6398"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a05d1decbb08d1f9368bc9a0d3dfd6398">Hazelnp::Hazelnupp::ClearAbbreviation</a></div><div class="ttdeci">void ClearAbbreviation(const std::string &amp;abbrevation)</div><div class="ttdoc">Will delete the abbreviation for a given parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00546">Hazelnupp.cpp:546</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_add731b65fb0741e4fb0b8fc8a601a11d"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#add731b65fb0741e4fb0b8fc8a601a11d">Hazelnp::Hazelnupp::RegisterConstraint</a></div><div class="ttdeci">void RegisterConstraint(const std::string &amp;key, const ParamConstraint &amp;constraint)</div><div class="ttdoc">Will register a constraint for a parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00598">Hazelnupp.cpp:598</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a300e55438cb0983b02347fdc3653e32c"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a300e55438cb0983b02347fdc3653e32c">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00362">Hazelnupp.cpp:362</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a63d6bdfc0d6255b5d663f3a786077eb4"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a63d6bdfc0d6255b5d663f3a786077eb4">Hazelnp::Hazelnupp::ClearConstraint</a></div><div class="ttdeci">void ClearConstraint(const std::string &amp;parameter)</div><div class="ttdoc">Will the constraint of a specific parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00547">Hazelnupp.cpp:547</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a46df7d396fb56e30351c9a7308792200"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00581">Hazelnupp.cpp:581</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a17845623ca686caa51f3c8254e85551e"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a17845623ca686caa51f3c8254e85551e">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00611">Hazelnupp.cpp:611</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a17883db87e97caad4a0f114f9f850f5e"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a17883db87e97caad4a0f114f9f850f5e">Hazelnp::Hazelnupp::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="Hazelnupp_8cpp_source.html#l00356">Hazelnupp.cpp:356</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Hazelnupp_html_a05d1decbb08d1f9368bc9a0d3dfd6398"><div class="ttname"><a href="classHazelnp_1_1Hazelnupp.html#a05d1decbb08d1f9368bc9a0d3dfd6398">Hazelnp::Hazelnupp::ClearAbbreviation</a></div><div class="ttdeci">void ClearAbbreviation(const std::string &amp;abbrevation)</div><div class="ttdoc">Will delete the abbreviation for a given parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Hazelnupp_8cpp_source.html#l00586">Hazelnupp.cpp:586</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 5 2021 12:40:11 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Jun 6 2021 15:32:07 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>