Skip to content

Commit

Permalink
Final documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
ARMmaster17 committed Aug 20, 2015
1 parent d680e0c commit af4e19a
Show file tree
Hide file tree
Showing 89 changed files with 802 additions and 675 deletions.
2 changes: 1 addition & 1 deletion docs/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classCore-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classCore.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classCrash-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/classCrash.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@

<p>Definition at line <a class="el" href="crash_8cpp_source.html#l00015">15</a> of file <a class="el" href="crash_8cpp_source.html">crash.cpp</a>.</p>

<p>Referenced by <a class="el" href="swap_8cpp_source.html#l00083">Swap::create()</a>, <a class="el" href="pbparse_8cpp_source.html#l00213">Parse::Opcode::System::END()</a>, <a class="el" href="pbparse_8cpp_source.html#l00152">Parse::Opcode::IO::Files::FILEREAD()</a>, <a class="el" href="pbparse_8cpp_source.html#l00131">Parse::Opcode::IO::Files::FILEWRITE()</a>, <a class="el" href="output_8cpp_source.html#l00022">Output::init()</a>, <a class="el" href="swap_8cpp_source.html#l00018">Swap::init()</a>, <a class="el" href="swap_8cpp_source.html#l00120">Swap::read()</a>, <a class="el" href="swap_8cpp_source.html#l00296">Swap::ready()</a>, <a class="el" href="pbparse_8cpp_source.html#l00050">Parse::run()</a>, <a class="el" href="swap_8cpp_source.html#l00275">Swap::sdelete()</a>, <a class="el" href="pbparse_8cpp_source.html#l00021">Parse::start()</a>, and <a class="el" href="output_8cpp_source.html#l00057">Output::write()</a>.</p>
<p>Referenced by <a class="el" href="swap_8cpp_source.html#l00083">Swap::create()</a>, <a class="el" href="pbparse_8cpp_source.html#l00213">Parse::Opcode::System::END()</a>, <a class="el" href="pbparse_8cpp_source.html#l00152">Parse::Opcode::IO::Files::FILEREAD()</a>, <a class="el" href="pbparse_8cpp_source.html#l00131">Parse::Opcode::IO::Files::FILEWRITE()</a>, <a class="el" href="swap_8cpp_source.html#l00018">Swap::init()</a>, <a class="el" href="output_8cpp_source.html#l00022">Output::init()</a>, <a class="el" href="swap_8cpp_source.html#l00129">Swap::read()</a>, <a class="el" href="swap_8cpp_source.html#l00314">Swap::ready()</a>, <a class="el" href="pbparse_8cpp_source.html#l00050">Parse::run()</a>, <a class="el" href="swap_8cpp_source.html#l00293">Swap::sdelete()</a>, <a class="el" href="pbparse_8cpp_source.html#l00021">Parse::start()</a>, and <a class="el" href="output_8cpp_source.html#l00057">Output::write()</a>.</p>
<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="comment">// Bad idea, may cause crash loop</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// Output::write(msg);</span></div>
Expand Down Expand Up @@ -158,7 +158,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classOutput-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/classOutput.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="output_8h_source.html#l00011">11</a> of file <a class="el" href="output_8h_source.html">output.h</a>.</p>
<p>Definition at line <a class="el" href="output_8h_source.html#l00015">15</a> of file <a class="el" href="output_8h_source.html">output.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abc5908ae5ec5de765d0f92433472e505"></a>
<div class="memitem">
Expand Down Expand Up @@ -238,7 +238,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:39 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse.html
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode_1_1IO-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
6 changes: 3 additions & 3 deletions docs/html/classParse_1_1Opcode_1_1IO.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,13 @@

<p>Definition at line <a class="el" href="pbparse_8cpp_source.html#l00098">98</a> of file <a class="el" href="pbparse_8cpp_source.html">pbparse.cpp</a>.</p>

<p>References <a class="el" href="swap_8cpp_source.html#l00120">Swap::read()</a>, and <a class="el" href="output_8cpp_source.html#l00057">Output::write()</a>.</p>
<p>References <a class="el" href="swap_8cpp_source.html#l00129">Swap::read()</a>, and <a class="el" href="output_8cpp_source.html#l00057">Output::write()</a>.</p>

<p>Referenced by <a class="el" href="pbparse_8cpp_source.html#l00050">Parse::run()</a>.</p>
<div class="fragment"><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="classOutput.html#a181cb63da3f2e530a5d790cfb018c81b">Output::write</a>(<a class="code" href="classSwap.html#a7dabb45b6cef4b4461b6757268aab48e">Swap::read</a>(_var));</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div>
<div class="ttc" id="classSwap_html_a7dabb45b6cef4b4461b6757268aab48e"><div class="ttname"><a href="classSwap.html#a7dabb45b6cef4b4461b6757268aab48e">Swap::read</a></div><div class="ttdeci">static String read(String name)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00120">swap.cpp:120</a></div></div>
<div class="ttc" id="classSwap_html_a7dabb45b6cef4b4461b6757268aab48e"><div class="ttname"><a href="classSwap.html#a7dabb45b6cef4b4461b6757268aab48e">Swap::read</a></div><div class="ttdeci">static String read(String name)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00129">swap.cpp:129</a></div></div>
<div class="ttc" id="classOutput_html_a181cb63da3f2e530a5d790cfb018c81b"><div class="ttname"><a href="classOutput.html#a181cb63da3f2e530a5d790cfb018c81b">Output::write</a></div><div class="ttdeci">static void write(String msg)</div><div class="ttdef"><b>Definition:</b> <a href="output_8cpp_source.html#l00057">output.cpp:57</a></div></div>
</div><!-- fragment -->
</div>
Expand All @@ -228,7 +228,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode_1_1IO_1_1Files-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
10 changes: 5 additions & 5 deletions docs/html/classParse_1_1Opcode_1_1IO_1_1Files.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@

<p>Definition at line <a class="el" href="pbparse_8cpp_source.html#l00152">152</a> of file <a class="el" href="pbparse_8cpp_source.html">pbparse.cpp</a>.</p>

<p>References <a class="el" href="crash_8cpp_source.html#l00015">Crash::forceHalt()</a>, and <a class="el" href="swap_8cpp_source.html#l00263">Swap::update()</a>.</p>
<p>References <a class="el" href="crash_8cpp_source.html#l00015">Crash::forceHalt()</a>, and <a class="el" href="swap_8cpp_source.html#l00281">Swap::update()</a>.</p>

<p>Referenced by <a class="el" href="pbparse_8cpp_source.html#l00050">Parse::run()</a>.</p>
<div class="fragment"><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; {</div>
Expand Down Expand Up @@ -170,7 +170,7 @@
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <a class="code" href="classSwap.html#a47d3cb82d24e3fb4a301aa0abb1ce280">Swap::update</a>(_var, _readbuf);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; _file.close();</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; }</div>
<div class="ttc" id="classSwap_html_a47d3cb82d24e3fb4a301aa0abb1ce280"><div class="ttname"><a href="classSwap.html#a47d3cb82d24e3fb4a301aa0abb1ce280">Swap::update</a></div><div class="ttdeci">static void update(String name, String value)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00263">swap.cpp:263</a></div></div>
<div class="ttc" id="classSwap_html_a47d3cb82d24e3fb4a301aa0abb1ce280"><div class="ttname"><a href="classSwap.html#a47d3cb82d24e3fb4a301aa0abb1ce280">Swap::update</a></div><div class="ttdeci">static void update(String name, String value)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00281">swap.cpp:281</a></div></div>
<div class="ttc" id="classCrash_html_a5e49d00985759d6c02688c3266570548"><div class="ttname"><a href="classCrash.html#a5e49d00985759d6c02688c3266570548">Crash::forceHalt</a></div><div class="ttdeci">static void forceHalt(String msg)</div><div class="ttdef"><b>Definition:</b> <a href="crash_8cpp_source.html#l00015">crash.cpp:15</a></div></div>
</div><!-- fragment -->
</div>
Expand Down Expand Up @@ -210,7 +210,7 @@

<p>Definition at line <a class="el" href="pbparse_8cpp_source.html#l00131">131</a> of file <a class="el" href="pbparse_8cpp_source.html">pbparse.cpp</a>.</p>

<p>References <a class="el" href="crash_8cpp_source.html#l00015">Crash::forceHalt()</a>, and <a class="el" href="swap_8cpp_source.html#l00120">Swap::read()</a>.</p>
<p>References <a class="el" href="crash_8cpp_source.html#l00015">Crash::forceHalt()</a>, and <a class="el" href="swap_8cpp_source.html#l00129">Swap::read()</a>.</p>

<p>Referenced by <a class="el" href="pbparse_8cpp_source.html#l00050">Parse::run()</a>.</p>
<div class="fragment"><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; {</div>
Expand All @@ -230,7 +230,7 @@
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; _file.flush();</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; _file.close();</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; }</div>
<div class="ttc" id="classSwap_html_a7dabb45b6cef4b4461b6757268aab48e"><div class="ttname"><a href="classSwap.html#a7dabb45b6cef4b4461b6757268aab48e">Swap::read</a></div><div class="ttdeci">static String read(String name)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00120">swap.cpp:120</a></div></div>
<div class="ttc" id="classSwap_html_a7dabb45b6cef4b4461b6757268aab48e"><div class="ttname"><a href="classSwap.html#a7dabb45b6cef4b4461b6757268aab48e">Swap::read</a></div><div class="ttdeci">static String read(String name)</div><div class="ttdef"><b>Definition:</b> <a href="swap_8cpp_source.html#l00129">swap.cpp:129</a></div></div>
<div class="ttc" id="classCrash_html_a5e49d00985759d6c02688c3266570548"><div class="ttname"><a href="classCrash.html#a5e49d00985759d6c02688c3266570548">Crash::forceHalt</a></div><div class="ttdeci">static void forceHalt(String msg)</div><div class="ttdef"><b>Definition:</b> <a href="crash_8cpp_source.html#l00015">crash.cpp:15</a></div></div>
</div><!-- fragment -->
</div>
Expand All @@ -242,7 +242,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode_1_1IO_1_1Ports-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode_1_1IO_1_1Ports.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classParse_1_1Opcode_1_1Logic-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 17 2015 15:52:40 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Aug 20 2015 13:54:48 for Octoduino by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
Loading

0 comments on commit af4e19a

Please sign in to comment.