Skip to content

Commit 31820ed

Browse files
committed
docs: Regenerate doxygen docs for 1.0.1
1 parent 4eb9e61 commit 31820ed

File tree

202 files changed

+3908
-2641
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+3908
-2641
lines changed

docs/html/AceRoutine_8h_source.html

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.13"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>AceRoutine: /home/brian/dev/AceRoutine/src/AceRoutine.h Source File</title>
8+
<title>AceRoutine: /home/brian/src/AceRoutine/src/AceRoutine.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
@@ -22,7 +22,7 @@
2222
<tr style="height: 56px;">
2323
<td id="projectalign" style="padding-left: 0.5em;">
2424
<div id="projectname">AceRoutine
25-
&#160;<span id="projectnumber">1.0</span>
25+
&#160;<span id="projectnumber">1.0.1</span>
2626
</div>
2727
<div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
2828
</td>
@@ -31,18 +31,21 @@
3131
</table>
3232
</div>
3333
<!-- end header part -->
34-
<!-- Generated by Doxygen 1.8.13 -->
34+
<!-- Generated by Doxygen 1.8.17 -->
3535
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
3637
var searchBox = new SearchBox("searchBox", "search",false,'Search');
38+
/* @license-end */
3739
</script>
3840
<script type="text/javascript" src="menudata.js"></script>
3941
<script type="text/javascript" src="menu.js"></script>
4042
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4144
$(function() {
4245
initMenu('',true,false,'search.php','Search');
4346
$(document).ready(function() { init_search(); });
4447
});
45-
</script>
48+
/* @license-end */</script>
4649
<div id="main-nav"></div>
4750
<!-- window showing the filter options -->
4851
<div id="MSearchSelectWindow"
@@ -68,13 +71,49 @@
6871
<div class="title">AceRoutine.h</div> </div>
6972
</div><!--header-->
7073
<div class="contents">
71-
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">MIT License</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">Copyright (c) 2018 Brian T. Park</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#ifndef ACE_ROUTINE_ACE_ROUTINE_H</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_ACE_ROUTINE_H</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Coroutine_8h.html">ace_routine/Coroutine.h</a>&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;ace_routine/CoroutineScheduler.h&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;ace_routine/Channel.h&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10000</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.0&quot;</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="Coroutine_8h_html"><div class="ttname"><a href="Coroutine_8h.html">Coroutine.h</a></div><div class="ttdoc">All coroutines are instances of the Coroutine base class. </div></div>
74+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
75+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">MIT License</span></div>
76+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"></span> </div>
77+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">Copyright (c) 2018 Brian T. Park</span></div>
78+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
79+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
80+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
81+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">in the Software without restriction, including without limitation the rights</span></div>
82+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
83+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">copies of the Software, and to permit persons to whom the Software is</span></div>
84+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">furnished to do so, subject to the following conditions:</span></div>
85+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span> </div>
86+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">The above copyright notice and this permission notice shall be included in all</span></div>
87+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">copies or substantial portions of the Software.</span></div>
88+
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span> </div>
89+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
90+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
91+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
92+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
93+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
94+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
95+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">SOFTWARE.</span></div>
96+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">*/</span></div>
97+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
98+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#ifndef ACE_ROUTINE_ACE_ROUTINE_H</span></div>
99+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_ACE_ROUTINE_H</span></div>
100+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
101+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Coroutine_8h.html">ace_routine/Coroutine.h</a>&quot;</span></div>
102+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;ace_routine/CoroutineScheduler.h&quot;</span></div>
103+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;ace_routine/Channel.h&quot;</span></div>
104+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
105+
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
106+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10001</span></div>
107+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.0.1&quot;</span></div>
108+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
109+
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
72110
</div><!-- fragment --></div><!-- contents -->
111+
<div class="ttc" id="aCoroutine_8h_html"><div class="ttname"><a href="Coroutine_8h.html">Coroutine.h</a></div></div>
73112
<!-- start footer part -->
74113
<hr class="footer"/><address class="footer"><small>
75114
Generated by &#160;<a href="http://www.doxygen.org/index.html">
76115
<img class="footer" src="doxygen.png" alt="doxygen"/>
77-
</a> 1.8.13
116+
</a> 1.8.17
78117
</small></address>
79118
</body>
80119
</html>

docs/html/Channel_8h_source.html

Lines changed: 115 additions & 15 deletions
Large diffs are not rendered by default.

docs/html/CommandDispatcher_8cpp_source.html

Lines changed: 160 additions & 23 deletions
Large diffs are not rendered by default.

docs/html/CommandDispatcher_8h_source.html

Lines changed: 168 additions & 29 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)