Built mkdocs

This commit is contained in:
Leonetienne
2021-09-05 12:12:03 +02:00
parent 1a4869faa1
commit c0c5a3a06d
202 changed files with 2546 additions and 1638 deletions

View File

@@ -175,12 +175,30 @@ $(function() {
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; };</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; };</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"> /** Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied alongside at least one of those incompatible ones</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html"> 101</a></span>&#160; <span class="keyword">class </span><a class="code" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html">HazelnuppConstraintIncompatibleParameters</a> : <span class="keyword">public</span> <a class="code" href="classHazelnp_1_1HazelnuppConstraintException.html">HazelnuppConstraintException</a></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#a3eceb69d0d4794252ab41b0d2b22ef3d"> 104</a></span>&#160; <a class="code" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#a3eceb69d0d4794252ab41b0d2b22ef3d">HazelnuppConstraintIncompatibleParameters</a>() : <a class="code" href="classHazelnp_1_1HazelnuppConstraintException.html">HazelnuppConstraintException</a>() {};</div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#ad9427954049ceb66f42130ac8476dc46"> 105</a></span>&#160; <a class="code" href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#ad9427954049ceb66f42130ac8476dc46">HazelnuppConstraintIncompatibleParameters</a>(<span class="keyword">const</span> std::string&amp; key1, <span class="keyword">const</span> std::string&amp; key2)</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="comment">// Generate descriptive error message</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; std::stringstream ss;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Parameter \&quot;&quot;</span> &lt;&lt; key1 &lt;&lt; <span class="stringliteral">&quot;\&quot; is NOT compatible with parameter \&quot;&quot;</span> &lt;&lt; key2 &lt;&lt; <span class="stringliteral">&quot;\&quot;!&quot;</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">message</a> = ss.str();</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; };</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; };</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</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="CmdArgsInterface_8h_source.html#l00007">CmdArgsInterface.h:7</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#l00009">CmdArgsInterface.h:9</a></div></div>
<div class="ttc" id="aDataType_8h_html"><div class="ttname"><a href="DataType_8h.html">DataType.h</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppInvalidKeyException_html_a18a08dc4efe80a378216460db5769891"><div class="ttname"><a href="classHazelnp_1_1HazelnuppInvalidKeyException.html#a18a08dc4efe80a378216460db5769891">Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException</a></div><div class="ttdeci">HazelnuppInvalidKeyException(const std::string &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00033">HazelnuppException.h:33</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintException_html_a4d08002a96bf9b3da3c6e931a51960e9"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9">Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException</a></div><div class="ttdeci">HazelnuppConstraintException()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00050">HazelnuppException.h:50</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintIncompatibleParameters_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html">Hazelnp::HazelnuppConstraintIncompatibleParameters</a></div><div class="ttdoc">Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied along...</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00101">HazelnuppException.h:101</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppInvalidKeyException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppInvalidKeyException.html">Hazelnp::HazelnuppInvalidKeyException</a></div><div class="ttdoc">Gets thrown when an non-existent key gets dereferenced.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00029">HazelnuppException.h:29</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintException_html_a944f0e6a384e032a762c5892964e1cc0"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintException.html#a944f0e6a384e032a762c5892964e1cc0">Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException</a></div><div class="ttdeci">HazelnuppConstraintException(const std::string &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00051">HazelnuppException.h:51</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html_a816f823fe2ebd35076049e33b9f3c05c"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#a816f823fe2ebd35076049e33b9f3c05c">Hazelnp::HazelnuppException::HazelnuppException</a></div><div class="ttdeci">HazelnuppException(const std::string &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00015">HazelnuppException.h:15</a></div></div>
@@ -188,12 +206,14 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintMissingValue_html_aad4a7b5573790ddfbe1a453aef71eb10"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintMissingValue.html#aad4a7b5573790ddfbe1a453aef71eb10">Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue</a></div><div class="ttdeci">HazelnuppConstraintMissingValue()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00083">HazelnuppException.h:83</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintTypeMissmatch_html_ab7c9e9afd9d3286e563a7656785242e8"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#ab7c9e9afd9d3286e563a7656785242e8">Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch</a></div><div class="ttdeci">HazelnuppConstraintTypeMissmatch()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00059">HazelnuppException.h:59</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_1HazelnuppConstraintIncompatibleParameters_html_ad9427954049ceb66f42130ac8476dc46"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#ad9427954049ceb66f42130ac8476dc46">Hazelnp::HazelnuppConstraintIncompatibleParameters::HazelnuppConstraintIncompatibleParameters</a></div><div class="ttdeci">HazelnuppConstraintIncompatibleParameters(const std::string &amp;key1, const std::string &amp;key2)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00105">HazelnuppException.h:105</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_1HazelnuppConstraintMissingValue_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintMissingValue.html">Hazelnp::HazelnuppConstraintMissingValue</a></div><div class="ttdoc">Gets thrown when a parameter constrained to be required is not provided, and has no default value set...</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00080">HazelnuppException.h:80</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintTypeMissmatch_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html">Hazelnp::HazelnuppConstraintTypeMissmatch</a></div><div class="ttdoc">Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00056">HazelnuppException.h:56</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html_a0b21fd5d4f22e5e677b74eb0acd7c6ff"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#a0b21fd5d4f22e5e677b74eb0acd7c6ff">Hazelnp::HazelnuppException::HazelnuppException</a></div><div class="ttdeci">HazelnuppException()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00014">HazelnuppException.h:14</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html_aa905cabcd12f542dfc67638732737e88"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">Hazelnp::HazelnuppException::message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00024">HazelnuppException.h:24</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppValueNotConvertibleException_html_a7ba376cd7fc7edcb934ee0257d4867f2"><div class="ttname"><a href="classHazelnp_1_1HazelnuppValueNotConvertibleException.html#a7ba376cd7fc7edcb934ee0257d4867f2">Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException</a></div><div class="ttdeci">HazelnuppValueNotConvertibleException(const std::string &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00042">HazelnuppException.h:42</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintIncompatibleParameters_html_a3eceb69d0d4794252ab41b0d2b22ef3d"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html#a3eceb69d0d4794252ab41b0d2b22ef3d">Hazelnp::HazelnuppConstraintIncompatibleParameters::HazelnuppConstraintIncompatibleParameters</a></div><div class="ttdeci">HazelnuppConstraintIncompatibleParameters()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00104">HazelnuppException.h:104</a></div></div>
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803f"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">Hazelnp::DATA_TYPE</a></div><div class="ttdeci">DATA_TYPE</div><div class="ttdoc">The different data types a paramater can be.</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00008">DataType.h:8</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintMissingValue_html_a192ef8133047beadf8fc9f585d384c04"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintMissingValue.html#a192ef8133047beadf8fc9f585d384c04">Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue</a></div><div class="ttdeci">HazelnuppConstraintMissingValue(const std::string &amp;key, const std::string &amp;paramDescription=&quot;&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00084">HazelnuppException.h:84</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintTypeMissmatch_html_abd5ae6630884725b614e8fe603cccdc5"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#abd5ae6630884725b614e8fe603cccdc5">Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch</a></div><div class="ttdeci">HazelnuppConstraintTypeMissmatch(const std::string &amp;key, const DATA_TYPE requiredType, const DATA_TYPE actualType, const std::string &amp;paramDescription=&quot;&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00062">HazelnuppException.h:62</a></div></div>
@@ -204,7 +224,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1HazelnuppInvalidKeyException_html_ab23be8f7cb84129fa85ed1e7a0b280a0"><div class="ttname"><a href="classHazelnp_1_1HazelnuppInvalidKeyException.html#ab23be8f7cb84129fa85ed1e7a0b280a0">Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException</a></div><div class="ttdeci">HazelnuppInvalidKeyException()</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00032">HazelnuppException.h:32</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 4 2021 21:16:24 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Sep 5 2021 12:11:50 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>