Built mkdocs

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

View File

@@ -115,8 +115,8 @@ Collaboration diagram for Hazelnp::HazelnuppConstraintMissingValue:</div>
Public Member Functions</h2></td></tr>
<tr class="memitem:aad4a7b5573790ddfbe1a453aef71eb10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html#aad4a7b5573790ddfbe1a453aef71eb10">HazelnuppConstraintMissingValue</a> ()</td></tr>
<tr class="separator:aad4a7b5573790ddfbe1a453aef71eb10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20563650ba1ee63f23ddb973677dbdda"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html#a20563650ba1ee63f23ddb973677dbdda">HazelnuppConstraintMissingValue</a> (const std::string &amp;msg)</td></tr>
<tr class="separator:a20563650ba1ee63f23ddb973677dbdda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a192ef8133047beadf8fc9f585d384c04"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html#a192ef8133047beadf8fc9f585d384c04">HazelnuppConstraintMissingValue</a> (const std::string &amp;key, const std::string &amp;paramDescription=&quot;&quot;)</td></tr>
<tr class="separator:a192ef8133047beadf8fc9f585d384c04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classHazelnp_1_1HazelnuppConstraintException"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classHazelnp_1_1HazelnuppConstraintException')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classHazelnp_1_1HazelnuppConstraintException.html">Hazelnp::HazelnuppConstraintException</a></td></tr>
<tr class="memitem:a4d08002a96bf9b3da3c6e931a51960e9 inherit pub_methods_classHazelnp_1_1HazelnuppConstraintException"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9">HazelnuppConstraintException</a> ()</td></tr>
<tr class="separator:a4d08002a96bf9b3da3c6e931a51960e9 inherit pub_methods_classHazelnp_1_1HazelnuppConstraintException"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -140,7 +140,7 @@ Additional Inherited Members</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Gets thrown when a parameter constrained to be required is not provided, and has no default value set. </p>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00062">62</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00080">80</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aad4a7b5573790ddfbe1a453aef71eb10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad4a7b5573790ddfbe1a453aef71eb10">&#9670;&nbsp;</a></span>HazelnuppConstraintMissingValue() <span class="overload">[1/2]</span></h2>
@@ -165,13 +165,13 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00065">65</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;: <a class="code" href="classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9">HazelnuppConstraintException</a>() {};</div>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00083">83</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;: <a class="code" href="classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9">HazelnuppConstraintException</a>() {};</div>
</div><!-- fragment -->
</div>
</div>
<a id="a20563650ba1ee63f23ddb973677dbdda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20563650ba1ee63f23ddb973677dbdda">&#9670;&nbsp;</a></span>HazelnuppConstraintMissingValue() <span class="overload">[2/2]</span></h2>
<a id="a192ef8133047beadf8fc9f585d384c04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a192ef8133047beadf8fc9f585d384c04">&#9670;&nbsp;</a></span>HazelnuppConstraintMissingValue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -183,8 +183,18 @@ Additional Inherited Members</h2></td></tr>
<td class="memname">Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>paramDescription</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
@@ -194,8 +204,19 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00066">66</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;: <a class="code" href="classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9">HazelnuppConstraintException</a>(msg) {};</div>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00084">84</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="comment">// Generate descriptive error message</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; std::stringstream ss;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Missing required parameter &quot;</span> &lt;&lt; key &lt;&lt; <span class="stringliteral">&quot;.&quot;</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// Add the parameter description, if provided</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">if</span> (paramDescription.length() &gt; 0)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; ss &lt;&lt; std::endl &lt;&lt; key &lt;&lt; <span class="stringliteral">&quot; =&gt; &quot;</span> &lt;&lt; paramDescription;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">message</a> = ss.str();</div>
<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><!-- fragment -->
</div>
</div>
@@ -203,10 +224,11 @@ Additional Inherited Members</h2></td></tr>
<li>Hazelnupp/<a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a></li>
</ul>
</div><!-- contents -->
<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#l00047">HazelnuppException.h:47</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_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>
<!-- 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:08 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>