mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -145,10 +145,10 @@ $(document).ready(function(){initNavTree('commandLine_8cpp_source.html',''); ini
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  CLI::App::add_flag_callback(</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="stringliteral">"--description"</span>,</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  [disptn, appName]() {</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<span class="stringliteral">"\n"</span><<<a class="code" href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a>(<a class="code" href="classpFlow_1_1commandLine.html#aea06e98469774a68c6962a88b0bb89ce">versoinCopyright</a>)<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<a class="code" href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a>(<a class="code" href="namespacepFlow.html#a8618ad0dd0cc0dda06724d40b728c96e">floatingPointDescription</a>())<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a><<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<span class="stringliteral">"Description for "</span><< <a class="code" href="streams_8hpp.html#ada7e7f1dc8af64d36d9b34fce99da38e">boldText</a>(appName)<<<span class="stringliteral">":\n"</span>;</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<span class="stringliteral">" "</span><<disptn<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a><<<span class="stringliteral">"\n"</span><<<a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(<a class="code" href="classpFlow_1_1commandLine.html#aea06e98469774a68c6962a88b0bb89ce">versoinCopyright</a>)<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a><<<a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(<a class="code" href="namespacepFlow.html#a6db03e44eeb9661c768aec3ea58484c7">floatingPointDescription</a>())<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a><<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a><<<span class="stringliteral">"Description for "</span><< <a class="code" href="iOstream_8hpp.html#a1d2aa4542eb9ce3820d6bb9a89ed3cdb">Bold_Text</a>(appName)<<<span class="stringliteral">":\n"</span>;</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a><<<span class="stringliteral">" "</span><<disptn<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  },</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="stringliteral">"What does this app do?"</span></div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  )->configurable(<span class="keyword">false</span>);</div>
|
||||
@ -172,19 +172,19 @@ $(document).ready(function(){initNavTree('commandLine_8cpp_source.html',''); ini
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aVectorFwd_8hpp_html_a3557595cfa50bcbd2098e44fe7da1bbd"><div class="ttname"><a href="VectorFwd_8hpp.html#a3557595cfa50bcbd2098e44fe7da1bbd">count</a></div><div class="ttdeci">auto count(const Vector< T, Allocator > &vec, const T &val)</div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a3b4a2b317fde2e633c19612003db8859"><div class="ttname"><a href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">pFlow::mOutput</a></div><div class="ttdeci">masterOstream mOutput</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_a7f04090943d139b6d697f4a194a3641d"><div class="ttname"><a href="classpFlow_1_1commandLine.html#a7f04090943d139b6d697f4a194a3641d">pFlow::commandLine::appName_</a></div><div class="ttdeci">word appName_</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00050">commandLine.hpp:50</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html"><div class="ttname"><a href="classpFlow_1_1commandLine.html">pFlow::commandLine</a></div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00036">commandLine.hpp:36</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
|
||||
<div class="ttc" id="aiOstream_8hpp_html_a06734f691d48f8796526b96cd58b982c"><div class="ttname"><a href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a></div><div class="ttdeci">#define Yellow_Text(text)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00040">iOstream.hpp:40</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_af199716992f3f8bb51c89ddcca847062"><div class="ttname"><a href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062">pFlow::commandLine::parse</a></div><div class="ttdeci">bool parse(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8cpp_source.html#l00050">commandLine.cpp:50</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_aea06e98469774a68c6962a88b0bb89ce"><div class="ttname"><a href="classpFlow_1_1commandLine.html#aea06e98469774a68c6962a88b0bb89ce">pFlow::commandLine::versoinCopyright</a></div><div class="ttdeci">static word versoinCopyright</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00062">commandLine.hpp:62</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a86ae30c22a4ef4bc487b40ed52f4d2f9"><div class="ttname"><a href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">pFlow::output</a></div><div class="ttdeci">Ostream output</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_abaf8950d8dfd816efcbf7d1fac3864cf"><div class="ttname"><a href="classpFlow_1_1commandLine.html#abaf8950d8dfd816efcbf7d1fac3864cf">pFlow::commandLine::commandLine</a></div><div class="ttdeci">commandLine(word appName)</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8cpp_source.html#l00024">commandLine.cpp:24</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_ada7e7f1dc8af64d36d9b34fce99da38e"><div class="ttname"><a href="streams_8hpp.html#ada7e7f1dc8af64d36d9b34fce99da38e">boldText</a></div><div class="ttdeci">#define boldText(text)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00035">streams.hpp:35</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_a6432f1237593152a2ca882342fb3abba"><div class="ttname"><a href="classpFlow_1_1commandLine.html#a6432f1237593152a2ca882342fb3abba">pFlow::commandLine::versionName</a></div><div class="ttdeci">static word versionName</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00060">commandLine.hpp:60</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a8618ad0dd0cc0dda06724d40b728c96e"><div class="ttname"><a href="namespacepFlow.html#a8618ad0dd0cc0dda06724d40b728c96e">pFlow::floatingPointDescription</a></div><div class="ttdeci">auto floatingPointDescription()</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00066">builtinTypes.hpp:66</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_adc698d020468722ea41a083f9ac491ed"><div class="ttname"><a href="classpFlow_1_1commandLine.html#adc698d020468722ea41a083f9ac491ed">pFlow::commandLine::ParseError</a></div><div class="ttdeci">CLI::ParseError ParseError</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00044">commandLine.hpp:44</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_a71e567553baf2a24a11e442683cde599"><div class="ttname"><a href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a></div><div class="ttdeci">#define yellowText(text)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00030">streams.hpp:30</a></div></div>
|
||||
<div class="ttc" id="aiOstream_8hpp_html_a1d2aa4542eb9ce3820d6bb9a89ed3cdb"><div class="ttname"><a href="iOstream_8hpp.html#a1d2aa4542eb9ce3820d6bb9a89ed3cdb">Bold_Text</a></div><div class="ttdeci">#define Bold_Text(text)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00045">iOstream.hpp:45</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a6db03e44eeb9661c768aec3ea58484c7"><div class="ttname"><a href="namespacepFlow.html#a6db03e44eeb9661c768aec3ea58484c7">pFlow::floatingPointDescription</a></div><div class="ttdeci">word floatingPointDescription()</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00069">builtinTypes.hpp:69</a></div></div>
|
||||
<div class="ttc" id="acommandLine_8hpp_html"><div class="ttname"><a href="commandLine_8hpp.html">commandLine.hpp</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
|
||||
Reference in New Issue
Block a user