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

479
docs/classHazelnp_1_1Hazelnupp.html
View File

@@ -281,11 +281,11 @@ Public Member Functions</h2></td></tr>
<p><br />
IMPORTANT: This parameter is the abbreviation! Not the long form! </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00546">546</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160;{</div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160; parameterAbreviations.erase(abbrevation);</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00586">586</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00587"></a><span class="lineno"> 587</span>&#160;{</div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>&#160; parameterAbreviations.erase(abbrevation);</div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -306,11 +306,11 @@ Public Member Functions</h2></td></tr>
<p>Will delete all abbreviations. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00552">552</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;{</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160; parameterAbreviations.clear();</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00592">592</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00593"></a><span class="lineno"> 593</span>&#160;{</div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>&#160; parameterAbreviations.clear();</div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -332,11 +332,11 @@ Public Member Functions</h2></td></tr>
<p>Will the constraint of a specific parameter. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00507">507</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160;{</div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160; parameterConstraints.erase(parameter);</div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00547">547</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160;{</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; parameterConstraints.erase(parameter);</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -357,11 +357,11 @@ Public Member Functions</h2></td></tr>
<p>Will delete all constraints. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00565">565</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160;{</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160; parameterConstraints.clear();</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00605">605</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160;{</div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>&#160; parameterConstraints.clear();</div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -383,12 +383,12 @@ Public Member Functions</h2></td></tr>
<p>Will delete the description of a parameter if it exists. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00346">346</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;{</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; <span class="comment">// This will just do nothing if the entry does not exist</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; parameterDescriptions.erase(parameter);</div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00378">378</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;{</div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; <span class="comment">// This will just do nothing if the entry does not exist</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; parameterDescriptions.erase(parameter);</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -409,11 +409,11 @@ Public Member Functions</h2></td></tr>
<p>Will delete all parameter descriptions. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00353">353</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;{</div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; parameterDescriptions.clear();</div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00385">385</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;{</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160; parameterDescriptions.clear();</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -434,114 +434,119 @@ Public Member Functions</h2></td></tr>
<p>Will generate a text-based documentation suited to show the user, for example on &ndash;help. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00359">359</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;{</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; std::stringstream ss;</div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; </div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; <span class="comment">// Add brief, if available</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; <span class="keywordflow">if</span> (briefDescription.length() &gt; 0)</div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; ss &lt;&lt; briefDescription &lt;&lt; std::endl;</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; </div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; <span class="comment">// Collect parameter information</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160; <span class="keyword">struct </span>ParamDocEntry</div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; {</div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; std::string abbreviation;</div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; std::string description;</div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160; std::string type;</div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160; <span class="keywordtype">bool</span> required = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160; <span class="keywordtype">bool</span> typeIsForced = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; std::string defaultVal;</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; };</div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160; std::unordered_map&lt;std::string, ParamDocEntry&gt; paramInfos;</div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; </div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; <span class="comment">// Collect descriptions</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterDescriptions)</div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; {</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160; paramInfos[it.first] = ParamDocEntry();</div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160; </div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160; paramInfos[it.first].description = it.second;</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; }</div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; </div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; <span class="comment">// Collect abbreviations</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; <span class="comment">// first value is abbreviation, second is long form</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterAbreviations)</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; {</div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.second) == paramInfos.end())</div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; paramInfos[it.second] = ParamDocEntry();</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00391">391</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;{</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; std::stringstream ss;</div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; </div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; <span class="comment">// Add brief, if available</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; <span class="keywordflow">if</span> (briefDescription.length() &gt; 0)</div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; ss &lt;&lt; briefDescription &lt;&lt; std::endl;</div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; </div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; paramInfos[it.second].abbreviation = it.first;</div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160; }</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; </div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160; <span class="comment">// Collect constraints</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterConstraints)</div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; {</div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; paramInfos[it.first] = ParamDocEntry();</div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; </div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; ParamDocEntry&amp; cached = paramInfos[it.first];</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; cached.required = it.second.required;</div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; cached.typeIsForced = it.second.constrainType;</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; cached.type = <a class="code" href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">DataTypeToString</a>(it.second.wantedType);</div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; </div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; std::stringstream defaultValueSs;</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> std::string&amp; s : it.second.defaultValue)</div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; {</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; defaultValueSs &lt;&lt; <span class="charliteral">&#39;\&#39;&#39;</span> &lt;&lt; s &lt;&lt; <span class="charliteral">&#39;\&#39;&#39;</span>;</div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; </div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; <span class="comment">// Add a space if we are not at the last entry</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; <span class="keywordflow">if</span> ((<span class="keywordtype">void</span>*)&amp;s != (<span class="keywordtype">void</span>*)&amp;it.second.defaultValue.back())</div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; defaultValueSs &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160; }</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; cached.defaultVal = defaultValueSs.str();</div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; }</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; </div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; <span class="comment">// Now generate the documentatino body</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; <span class="keywordflow">if</span> (paramInfos.size() &gt; 0)</div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160; {</div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; ss &lt;&lt; std::endl </div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; &lt;&lt; <span class="stringliteral">&quot;==== AVAILABLE PARAMETERS ====&quot;</span> </div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; <span class="comment">// Collect parameter information</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160; <span class="keyword">struct </span>ParamDocEntry</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; {</div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160; std::string abbreviation;</div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; std::string description;</div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; std::string type;</div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; <span class="keywordtype">bool</span> required = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; <span class="keywordtype">bool</span> typeIsForced = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; std::string defaultVal;</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; };</div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; std::unordered_map&lt;std::string, ParamDocEntry&gt; paramInfos;</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; </div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; <span class="comment">// Collect descriptions</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterDescriptions)</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; {</div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; paramInfos[it.first] = ParamDocEntry();</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; </div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; paramInfos[it.first].description = it.second;</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; }</div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; </div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; <span class="comment">// Collect abbreviations</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160; <span class="comment">// first value is abbreviation, second is long form</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterAbreviations)</div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; {</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.second) == paramInfos.end())</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160; paramInfos[it.second] = ParamDocEntry();</div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; </div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; paramInfos[it.second].abbreviation = it.first;</div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; }</div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; </div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : paramInfos)</div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; {</div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; <span class="keyword">const</span> ParamDocEntry&amp; pde = it.second;</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; </div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; <span class="comment">// Put name</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; ss &lt;&lt; it.first &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; </div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; <span class="comment">// Put abbreviation</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; <span class="keywordflow">if</span> (pde.abbreviation.length() &gt; 0)</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; ss &lt;&lt; pde.abbreviation &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; </div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; <span class="comment">// Put type</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160; <span class="keywordflow">if</span> (pde.typeIsForced)</div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160; ss &lt;&lt; pde.type &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; </div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160; <span class="comment">// Put default value</span></div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160; <span class="keywordflow">if</span> (pde.defaultVal.length() &gt; 0)</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;default=[&quot;</span> &lt;&lt; pde.defaultVal &lt;&lt; <span class="stringliteral">&quot;] &quot;</span>;</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160; </div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160; <span class="comment">// Put required tag, but only if no default value</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160; <span class="keywordflow">if</span> ((pde.required) &amp;&amp; (pde.defaultVal.length() == 0))</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;[[REQUIRED]] &quot;</span>;</div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160; </div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160; <span class="comment">// Put brief description</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160; <span class="keywordflow">if</span> (pde.description.length() &gt; 0)</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160; ss &lt;&lt; pde.description;</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160; </div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160; ss &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160; }</div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160; }</div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160; </div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160; <span class="keywordflow">return</span> ss.str();</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160;}</div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; <span class="comment">// Collect constraints</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : parameterConstraints)</div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; {</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; <span class="comment">// No? Create it.</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; paramInfos[it.first] = ParamDocEntry();</div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; </div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; ParamDocEntry&amp; cached = paramInfos[it.first];</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; cached.required = it.second.required;</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; cached.typeIsForced = it.second.constrainType;</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; cached.type = <a class="code" href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">DataTypeToString</a>(it.second.requiredType);</div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160; </div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160; std::stringstream defaultValueSs;</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> std::string&amp; s : it.second.defaultValue)</div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160; {</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160; defaultValueSs &lt;&lt; <span class="charliteral">&#39;\&#39;&#39;</span> &lt;&lt; s &lt;&lt; <span class="charliteral">&#39;\&#39;&#39;</span>;</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160; </div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160; <span class="comment">// Add a space if we are not at the last entry</span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160; <span class="keywordflow">if</span> ((<span class="keywordtype">void</span>*)&amp;s != (<span class="keywordtype">void</span>*)&amp;it.second.defaultValue.back())</div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160; defaultValueSs &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160; }</div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160; cached.defaultVal = defaultValueSs.str();</div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160; }</div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160; </div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160; <span class="comment">// Now generate the documentatino body</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160; <span class="keywordflow">if</span> (paramInfos.size() &gt; 0)</div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160; {</div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160; ss &lt;&lt; std::endl </div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160; &lt;&lt; <span class="stringliteral">&quot;==== AVAILABLE PARAMETERS ====&quot;</span> </div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160; &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160; </div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160; std::size_t counter = 0;</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; it : paramInfos)</div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160; {</div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160; <span class="keyword">const</span> ParamDocEntry&amp; pde = it.second;</div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>&#160; </div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160; <span class="comment">// Put name</span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160; ss &lt;&lt; it.first &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160; </div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160; <span class="comment">// Put abbreviation</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160; <span class="keywordflow">if</span> (pde.abbreviation.length() &gt; 0)</div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>&#160; ss &lt;&lt; pde.abbreviation &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160; </div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160; <span class="comment">// Put type</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160; <span class="keywordflow">if</span> (pde.typeIsForced)</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160; ss &lt;&lt; pde.type &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160; </div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>&#160; <span class="comment">// Put default value</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>&#160; <span class="keywordflow">if</span> (pde.defaultVal.length() &gt; 0)</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;default=[&quot;</span> &lt;&lt; pde.defaultVal &lt;&lt; <span class="stringliteral">&quot;] &quot;</span>;</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160; </div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160; <span class="comment">// Put required tag, but only if no default value</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160; <span class="keywordflow">if</span> ((pde.required) &amp;&amp; (pde.defaultVal.length() == 0))</div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;[[REQUIRED]] &quot;</span>;</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160; </div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160; <span class="comment">// Put brief description</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160; <span class="keywordflow">if</span> (pde.description.length() &gt; 0)</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160; ss &lt;&lt; pde.description;</div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160; </div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160; <span class="comment">// Omit linebreaks when we&#39;re on the last element</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160; <span class="keywordflow">if</span> (counter &lt; paramInfos.size()-1)</div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160; ss &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>&#160; </div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160; counter++;</div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160; }</div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160; }</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160; </div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160; <span class="keywordflow">return</span> ss.str();</div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -564,13 +569,13 @@ Public Member Functions</h2></td></tr>
<p>Will return the long form of an abbreviation (like &ndash;force for -f) <br />
Returns "" if no match is found. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00533">533</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00534"></a><span class="lineno"> 534</span>&#160;{</div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200">HasAbbreviation</a>(abbrev))</div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160; </div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160; <span class="keywordflow">return</span> parameterAbreviations.find(abbrev)-&gt;second;</div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00573">573</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160;{</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200">HasAbbreviation</a>(abbrev))</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160; </div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160; <span class="keywordflow">return</span> parameterAbreviations.find(abbrev)-&gt;second;</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -591,10 +596,10 @@ Public Member Functions</h2></td></tr>
<p>Returns the brief description of the application to be automatically added to the documentation. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00319">319</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;{</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; <span class="keywordflow">return</span> briefDescription;</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00351">351</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;{</div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; <span class="keywordflow">return</span> briefDescription;</div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -615,10 +620,10 @@ Public Member Functions</h2></td></tr>
<p>Retruns whether the <a class="el" href="classHazelnp_1_1Hazelnupp.html" title="The main class to interface with.">Hazelnupp</a> should automatically catch the &ndash;help parameter, print the parameter documentation to stdout, and exit or not. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00308">308</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;{</div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; <span class="keywordflow">return</span> catchHelp;</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00340">340</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;{</div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <span class="keywordflow">return</span> catchHelp;</div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -640,10 +645,10 @@ Public Member Functions</h2></td></tr>
<p>Will return the constraint information for a specific parameter. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00502">502</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160;{</div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160; <span class="keywordflow">return</span> parameterConstraints.find(parameter)-&gt;second;</div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00542">542</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160;{</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; <span class="keywordflow">return</span> parameterConstraints.find(parameter)-&gt;second;</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -664,10 +669,10 @@ Public Member Functions</h2></td></tr>
<p>Gets whether the application crashes on an exception whilst parsing, and prints to stderr. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00297">297</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;{</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; <span class="keywordflow">return</span> crashOnFail;</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00329">329</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;{</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; <span class="keywordflow">return</span> crashOnFail;</div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -691,16 +696,16 @@ Public Member Functions</h2></td></tr>
<p><br />
Empty string if it does not exist. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00330">330</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;{</div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; <span class="comment">// Do we already have a description for this parameter?</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#aabab94412ff5eecf95b97a4e21eb9cf6">HasDescription</a>(parameter))</div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; <span class="comment">// No? Then return &quot;&quot;</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; </div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; <span class="comment">// We do? Then return it</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <span class="keywordflow">return</span> parameterDescriptions.find(parameter)-&gt;second;</div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00362">362</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;{</div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; <span class="comment">// Do we already have a description for this parameter?</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#aabab94412ff5eecf95b97a4e21eb9cf6">HasDescription</a>(parameter))</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; <span class="comment">// No? Then return &quot;&quot;</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160; </div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; <span class="comment">// We do? Then return it</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; <span class="keywordflow">return</span> parameterDescriptions.find(parameter)-&gt;second;</div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -721,10 +726,10 @@ Public Member Functions</h2></td></tr>
<p>Will return argv[0], the name of the executable. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00513">513</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160;{</div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160; <span class="keywordflow">return</span> executableName;</div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00553">553</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;{</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160; <span class="keywordflow">return</span> executableName;</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -746,10 +751,10 @@ Public Member Functions</h2></td></tr>
<p>Will check wether or not an abbreviation is registered. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00541">541</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160;{</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; <span class="keywordflow">return</span> parameterAbreviations.find(abbrev) != parameterAbreviations.end();</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00581">581</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;{</div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160; <span class="keywordflow">return</span> parameterAbreviations.find(abbrev) != parameterAbreviations.end();</div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -771,10 +776,10 @@ Public Member Functions</h2></td></tr>
<p>Returns whether or not a given parameter has a registered description. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00341">341</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;{</div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; <span class="keywordflow">return</span> parameterDescriptions.find(parameter) != parameterDescriptions.end();</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00373">373</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;{</div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; <span class="keywordflow">return</span> parameterDescriptions.find(parameter) != parameterDescriptions.end();</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -821,14 +826,14 @@ Public Member Functions</h2></td></tr>
<p>Will return the value given a key. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00518">518</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160;{</div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160; <span class="comment">// Throw exception if param is unknown</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(key))</div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classHazelnp_1_1HazelnuppInvalidKeyException.html">HazelnuppInvalidKeyException</a>();</div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160; </div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160; <span class="keywordflow">return</span> *parameters.find(key)-&gt;second-&gt;GetValue();</div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00558">558</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;{</div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160; <span class="comment">// Throw exception if param is unknown</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(key))</div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classHazelnp_1_1HazelnuppInvalidKeyException.html">HazelnuppInvalidKeyException</a>();</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160; </div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160; <span class="keywordflow">return</span> *parameters.find(key)-&gt;second-&gt;GetValue();</div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -892,27 +897,27 @@ Public Member Functions</h2></td></tr>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">if</span> ((!catchHelp) || (!<a class="code" href="classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040">HasParam</a>(<span class="stringliteral">&quot;--help&quot;</span>)))</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; ApplyConstraints();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html">HazelnuppConstraintTypeMissmatch</a>&amp; hctm)</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html">HazelnuppConstraintTypeMissmatch</a>&amp; exc)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span> (crashOnFail)</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; std::cout &lt;&lt; <a class="code" href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">GenerateDocumentation</a>() &lt;&lt; std::endl;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; std::cerr &lt;&lt; <span class="stringliteral">&quot;Fatal error: Command-line parameter value-type mismatch at \&quot;&quot;</span> &lt;&lt; hctm.<a class="code" href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">What</a>() &lt;&lt; <span class="stringliteral">&quot;\&quot;!&quot;</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; std::cout &lt;&lt; <a class="code" href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">GenerateDocumentation</a>() &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; std::cerr &lt;&lt; <span class="stringliteral">&quot;Parameter error: &quot;</span> &lt;&lt; exc.<a class="code" href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">What</a>() &lt;&lt; std::endl;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; quick_exit(-1009);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">throw</span> hctm; <span class="comment">// yeet</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">throw</span> exc; <span class="comment">// yeet</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html">HazelnuppConstraintMissingValue</a>&amp; hctm)</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html">HazelnuppConstraintMissingValue</a>&amp; exc)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">if</span> (crashOnFail)</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; std::cout &lt;&lt; <a class="code" href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">GenerateDocumentation</a>() &lt;&lt; std::endl;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::cerr &lt;&lt; <span class="stringliteral">&quot;Fatal error: Missing required command-line parameter \&quot;&quot;</span> &lt;&lt; hctm.<a class="code" href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">What</a>() &lt;&lt; <span class="stringliteral">&quot;\&quot;!&quot;</span>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; std::cout &lt;&lt; <a class="code" href="classHazelnp_1_1Hazelnupp.html#a7b1bf5e700d8a0d8e90c5750e54749de">GenerateDocumentation</a>() &lt;&lt; std::endl &lt;&lt; std::endl;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::cerr &lt;&lt; <span class="stringliteral">&quot;Parameter error: &quot;</span> &lt;&lt; exc.<a class="code" href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">What</a>() &lt;&lt; std::endl;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; quick_exit(-1010);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">throw</span> hctm; <span class="comment">// yeet</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">throw</span> exc; <span class="comment">// yeet</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; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// Catch --help parameter</span></div>
@@ -955,11 +960,11 @@ Public Member Functions</h2></td></tr>
<p>Will register an abbreviation (like -f for &ndash;force) </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00527">527</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00528"></a><span class="lineno"> 528</span>&#160;{</div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160; parameterAbreviations.insert(std::pair&lt;std::string, std::string&gt;(abbrev, target));</div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00567">567</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;{</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160; parameterAbreviations.insert(std::pair&lt;std::string, std::string&gt;(abbrev, target));</div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -992,12 +997,12 @@ Public Member Functions</h2></td></tr>
<p>Will register a constraint for a parameter. </p>
<p>IMPORTANT: Any parameter can only have ONE constraint. Applying a new one will overwrite the old one! Construct the <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> struct yourself to combine Require and TypeSafety! You can also use the <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> constructor! </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00558">558</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;{</div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160; <span class="comment">// Magic syntax, wooo</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160; (parameterConstraints[key] = constraint).key = key;</div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00598">598</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160;{</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160; <span class="comment">// Magic syntax, wooo</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160; (parameterConstraints[key] = constraint).key = key;</div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -1031,11 +1036,11 @@ Public Member Functions</h2></td></tr>
<p><br />
Will overwrite existing descriptions for that parameter. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00324">324</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;{</div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; parameterDescriptions[parameter] = description;</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00356">356</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;{</div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; parameterDescriptions[parameter] = description;</div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -1057,11 +1062,11 @@ Public Member Functions</h2></td></tr>
<p>Sets a brief description of the application to be automatically added to the documentation. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00313">313</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;{</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; briefDescription = description;</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00345">345</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;{</div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; briefDescription = description;</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -1083,11 +1088,11 @@ Public Member Functions</h2></td></tr>
<p>Sets whether the <a class="el" href="classHazelnp_1_1Hazelnupp.html" title="The main class to interface with.">Hazelnupp</a> should automatically catch the &ndash;help parameter, print the parameter documentation to stdout, and exit or not. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00302">302</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;{</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; this-&gt;catchHelp = catchHelp;</div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00334">334</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;{</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; this-&gt;catchHelp = catchHelp;</div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -1109,11 +1114,11 @@ Public Member Functions</h2></td></tr>
<p>Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not. </p>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00571">571</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160;{</div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160; this-&gt;crashOnFail = crashOnFail;</div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160;}</div>
<p class="definition">Definition at line <a class="el" href="Hazelnupp_8cpp_source.html#l00611">611</a> of file <a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00612"></a><span class="lineno"> 612</span>&#160;{</div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160; this-&gt;crashOnFail = crashOnFail;</div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -1122,22 +1127,22 @@ Public Member Functions</h2></td></tr>
<li>Hazelnupp/<a class="el" href="Hazelnupp_8cpp_source.html">Hazelnupp.cpp</a></li>
</ul>
</div><!-- contents -->
<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#l00026">HazelnuppException.h:26</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_1HazelnuppException_html_aa86c415a0f2b4ea5f11892145d1ea83e"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">Hazelnp::HazelnuppException::What</a></div><div class="ttdeci">const std::string &amp; What() const</div><div class="ttdoc">Will return an error message.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00015">HazelnuppException.h:15</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_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_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_1HazelnuppException_html_aa86c415a0f2b4ea5f11892145d1ea83e"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">Hazelnp::HazelnuppException::What</a></div><div class="ttdeci">const std::string &amp; What() const</div><div class="ttdoc">Will return an error message.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00018">HazelnuppException.h:18</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_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="anamespaceHazelnp_1_1Placeholders_html_a90536f0cd5261b18da736e954c6b8b79"><div class="ttname"><a href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Hazelnp::Placeholders::g_emptyString</a></div><div class="ttdeci">static const std::string g_emptyString</div><div class="ttdoc">The only purpose of this is to provide the ability to return an empty string as an error for std::str...</div><div class="ttdef"><b>Definition:</b> <a href="Placeholders_8h_source.html#l00009">Placeholders.h:9</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_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>
<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#l00062">HazelnuppException.h:62</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#l00053">HazelnuppException.h:53</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_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_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="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>
<!-- 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>