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

Compiled doxygen

Browse Source
This commit is contained in:
Leonetienne
2021-09-05 12:57:10 +02:00
parent 069d544e02
commit e3fe859b9e
178 changed files with 727 additions and 520 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CmdArgsInterface_8cpp_source.html
View File

@@ -788,7 +788,7 @@ $(function() {
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">Hazelnp::DATA_TYPE::VOID</a></div><div class="ttdeci">@ VOID</div></div>
<div class="ttc" id="aclassHazelnp_1_1FloatValue_html"><div class="ttname"><a href="classHazelnp_1_1FloatValue.html">Hazelnp::FloatValue</a></div><div class="ttdoc">Specializations for floating point values (uses long double)</div><div class="ttdef"><b>Definition:</b> <a href="FloatValue_8h_source.html#l00009">FloatValue.h:9</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a112d2d5e3fd1cf1507592389c8454984"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a112d2d5e3fd1cf1507592389c8454984">Hazelnp::CmdArgsInterface::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="CmdArgsInterface_8cpp_source.html#l00612">CmdArgsInterface.cpp:612</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">Hazelnp::ParamConstraint::requiredType</a></div><div class="ttdeci">DATA_TYPE requiredType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00073">ParamConstraint.h:73</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">Hazelnp::ParamConstraint::requiredType</a></div><div class="ttdeci">DATA_TYPE requiredType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00106">ParamConstraint.h:106</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="aclassHazelnp_1_1HazelnuppConstraintException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintException.html">Hazelnp::HazelnuppConstraintException</a></div><div class="ttdoc">Gets thrown something bad happens because of parameter constraints.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00047">HazelnuppException.h:47</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_aaccf591a74408aeb4363033fe8cb2224"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#aaccf591a74408aeb4363033fe8cb2224">Hazelnp::CmdArgsInterface::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="CmdArgsInterface_8cpp_source.html#l00632">CmdArgsInterface.cpp:632</a></div></div>
@@ -802,7 +802,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a5003f826ee31c6365bf4b6e8b2c8d9f1"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a5003f826ee31c6365bf4b6e8b2c8d9f1">Hazelnp::CmdArgsInterface::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="CmdArgsInterface_8cpp_source.html#l00407">CmdArgsInterface.cpp:407</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a62889ce1faa90d0f20be3ae45803baa0"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a62889ce1faa90d0f20be3ae45803baa0">Hazelnp::CmdArgsInterface::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="CmdArgsInterface_8cpp_source.html#l00412">CmdArgsInterface.cpp:412</a></div></div>
<div class="ttc" id="aListValue_8h_html"><div class="ttname"><a href="ListValue_8h.html">ListValue.h</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">Hazelnp::ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00070">ParamConstraint.h:70</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">Hazelnp::ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00103">ParamConstraint.h:103</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html">Hazelnp::HazelnuppException</a></div><div class="ttdoc">Generic hazelnupp exception.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00011">HazelnuppException.h:11</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_aa1189c249bf0d8a4fbd5fb8f03a30212"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#aa1189c249bf0d8a4fbd5fb8f03a30212">Hazelnp::CmdArgsInterface::CmdArgsInterface</a></div><div class="ttdeci">CmdArgsInterface()</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00015">CmdArgsInterface.cpp:15</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1Parameter_html_a7acd68ce06eec06ab286b1a062f9c8d6"><div class="ttname"><a href="classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6">Hazelnp::Parameter::Key</a></div><div class="ttdeci">const std::string &amp; Key() const</div><div class="ttdoc">Will return the key of this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8cpp_source.html#l00021">Parameter.cpp:21</a></div></div>
@@ -837,7 +837,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 Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Sep 5 2021 12:56:57 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>