Skip to content

Commit dddfd58

Browse files
bxparksbxparks
committed
docs: Regenerate doxygen
1 parent 5a2c86d commit dddfd58

File tree

153 files changed

+1543
-1201
lines changed

Some content is hidden

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

153 files changed

+1543
-1201
lines changed

‎docs/html/AceRoutine_8h_source.html‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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.17"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>AceRoutine: /home/brian/src/AceRoutine/src/AceRoutine.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -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.5.0</span>
25+
&#160;<span id="projectnumber">1.5.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,10 +31,10 @@
3131
</table>
3232
</div>
3333
<!-- end header part -->
34-
<!-- Generated by Doxygen 1.8.17 -->
34+
<!-- Generated by Doxygen 1.9.1 -->
3535
<script type="text/javascript">
3636
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37-
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
3838
/* @license-end */
3939
</script>
4040
<script type="text/javascript" src="menudata.js"></script>
@@ -105,8 +105,8 @@
105105
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
106106
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
107107
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
108-
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10500</span></div>
109-
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.5.0&quot;</span></div>
108+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10501</span></div>
109+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.5.1&quot;</span></div>
110110
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
111111
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Coroutine_8h.html">ace_routine/Coroutine.h</a>&quot;</span></div>
112112
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#include &quot;ace_routine/CoroutineScheduler.h&quot;</span></div>
@@ -117,13 +117,11 @@
117117
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#include &quot;ace_routine/LogBinJsonRenderer.h&quot;</span></div>
118118
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
119119
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif</span></div>
120+
<div class="ttc" id="aCoroutine_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>
120121
</div><!-- fragment --></div><!-- contents -->
121-
<div class="ttc" id="aCoroutine_8h_html"><div class="ttname"><a href="Coroutine_8h.html">Coroutine.h</a></div></div>
122122
<!-- start footer part -->
123123
<hr class="footer"/><address class="footer"><small>
124-
Generated by &#160;<a href="http://www.doxygen.org/index.html">
125-
<img class="footer" src="doxygen.png" alt="doxygen"/>
126-
</a> 1.8.17
124+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
127125
</small></address>
128126
</body>
129127
</html>

‎docs/html/Channel_8h_source.html‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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.17"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>AceRoutine: /home/brian/src/AceRoutine/src/ace_routine/Channel.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -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.5.0</span>
25+
&#160;<span id="projectnumber">1.5.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,10 +31,10 @@
3131
</table>
3232
</div>
3333
<!-- end header part -->
34-
<!-- Generated by Doxygen 1.8.17 -->
34+
<!-- Generated by Doxygen 1.9.1 -->
3535
<script type="text/javascript">
3636
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37-
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
3838
/* @license-end */
3939
</script>
4040
<script type="text/javascript" src="menudata.js"></script>
@@ -169,19 +169,17 @@
169169
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;}</div>
170170
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
171171
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#endif</span></div>
172-
</div><!-- fragment --></div><!-- contents -->
173-
<div class="ttc" id="aclassace__routine_1_1Channel_html_a1134e9c905c7c0bb7255f208534355d8"><div class="ttname"><a href="classace__routine_1_1Channel.html#a1134e9c905c7c0bb7255f208534355d8">ace_routine::Channel::write</a></div><div class="ttdeci">bool write(const T &amp;value)</div><div class="ttdoc">Write the given value to the channel through the COROUTINE_AWAIT() if value is a static variable.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00084">Channel.h:84</a></div></div>
174-
<div class="ttc" id="aclassace__routine_1_1Channel_html_ae004356c45d9017d0e375d4468b094e2"><div class="ttname"><a href="classace__routine_1_1Channel.html#ae004356c45d9017d0e375d4468b094e2">ace_routine::Channel::Channel</a></div><div class="ttdeci">Channel()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00046">Channel.h:46</a></div></div>
175-
<div class="ttc" id="aclassace__routine_1_1Channel_html_ab950ccdf77fdfaeea67ac19031733229"><div class="ttname"><a href="classace__routine_1_1Channel.html#ab950ccdf77fdfaeea67ac19031733229">ace_routine::Channel::setValue</a></div><div class="ttdeci">void setValue(const T &amp;value)</div><div class="ttdoc">Used by COROUTINE_CHANNEL_WRITE() to preserve the value of the write across multiple COROUTINE_YIELD(...</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00053">Channel.h:53</a></div></div>
172+
<div class="ttc" id="aCoroutine_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>
176173
<div class="ttc" id="aclassace__routine_1_1Channel_html"><div class="ttname"><a href="classace__routine_1_1Channel.html">ace_routine::Channel</a></div><div class="ttdoc">An unbuffered synchronized channel.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00043">Channel.h:43</a></div></div>
174+
<div class="ttc" id="aclassace__routine_1_1Channel_html_a1134e9c905c7c0bb7255f208534355d8"><div class="ttname"><a href="classace__routine_1_1Channel.html#a1134e9c905c7c0bb7255f208534355d8">ace_routine::Channel::write</a></div><div class="ttdeci">bool write(const T &amp;value)</div><div class="ttdoc">Write the given value to the channel through the COROUTINE_AWAIT() if value is a static variable.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00084">Channel.h:84</a></div></div>
177175
<div class="ttc" id="aclassace__routine_1_1Channel_html_a931ce2344667a4b36e76bb4f8f3b70a0"><div class="ttname"><a href="classace__routine_1_1Channel.html#a931ce2344667a4b36e76bb4f8f3b70a0">ace_routine::Channel::read</a></div><div class="ttdeci">bool read(T &amp;value)</div><div class="ttdoc">Read the value through the COROUTINE_AWAIT() macro or the COROUTINE_CHANNEL_READ() macro.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00106">Channel.h:106</a></div></div>
178-
<div class="ttc" id="aCoroutine_8h_html"><div class="ttname"><a href="Coroutine_8h.html">Coroutine.h</a></div></div>
176+
<div class="ttc" id="aclassace__routine_1_1Channel_html_ab950ccdf77fdfaeea67ac19031733229"><div class="ttname"><a href="classace__routine_1_1Channel.html#ab950ccdf77fdfaeea67ac19031733229">ace_routine::Channel::setValue</a></div><div class="ttdeci">void setValue(const T &amp;value)</div><div class="ttdoc">Used by COROUTINE_CHANNEL_WRITE() to preserve the value of the write across multiple COROUTINE_YIELD(...</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00053">Channel.h:53</a></div></div>
179177
<div class="ttc" id="aclassace__routine_1_1Channel_html_ad7fa46d27162b4ec9ffa257f3881931d"><div class="ttname"><a href="classace__routine_1_1Channel.html#ad7fa46d27162b4ec9ffa257f3881931d">ace_routine::Channel::write</a></div><div class="ttdeci">bool write()</div><div class="ttdoc">Same as write(constT&amp; value) except use the value of setValue().</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00062">Channel.h:62</a></div></div>
178+
<div class="ttc" id="aclassace__routine_1_1Channel_html_ae004356c45d9017d0e375d4468b094e2"><div class="ttname"><a href="classace__routine_1_1Channel.html#ae004356c45d9017d0e375d4468b094e2">ace_routine::Channel::Channel</a></div><div class="ttdeci">Channel()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="Channel_8h_source.html#l00046">Channel.h:46</a></div></div>
179+
</div><!-- fragment --></div><!-- contents -->
180180
<!-- start footer part -->
181181
<hr class="footer"/><address class="footer"><small>
182-
Generated by &#160;<a href="http://www.doxygen.org/index.html">
183-
<img class="footer" src="doxygen.png" alt="doxygen"/>
184-
</a> 1.8.17
182+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
185183
</small></address>
186184
</body>
187185
</html>

‎docs/html/ClockInterface_8h_source.html‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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.17"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>AceRoutine: /home/brian/src/AceRoutine/src/ace_routine/ClockInterface.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -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.5.0</span>
25+
&#160;<span id="projectnumber">1.5.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,10 +31,10 @@
3131
</table>
3232
</div>
3333
<!-- end header part -->
34-
<!-- Generated by Doxygen 1.8.17 -->
34+
<!-- Generated by Doxygen 1.9.1 -->
3535
<script type="text/javascript">
3636
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37-
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
3838
/* @license-end */
3939
</script>
4040
<script type="text/javascript" src="menudata.js"></script>
@@ -115,16 +115,14 @@
115115
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}</div>
116116
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
117117
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif</span></div>
118-
</div><!-- fragment --></div><!-- contents -->
119-
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html_aeb6701bd63ee8fb7dbb81efaf0ac02bf"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html#aeb6701bd63ee8fb7dbb81efaf0ac02bf">ace_routine::ClockInterface::millis</a></div><div class="ttdeci">static unsigned long millis()</div><div class="ttdoc">Get the current millis.</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00043">ClockInterface.h:43</a></div></div>
120-
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html_a03c0d39e0167f8a8e7c41f09d19d2861"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html#a03c0d39e0167f8a8e7c41f09d19d2861">ace_routine::ClockInterface::seconds</a></div><div class="ttdeci">static unsigned long seconds()</div><div class="ttdoc">Get the current seconds.</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00063">ClockInterface.h:63</a></div></div>
121118
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html">ace_routine::ClockInterface</a></div><div class="ttdoc">A utility class (all methods are static) that provides a layer of indirection to Arduino clock functi...</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00040">ClockInterface.h:40</a></div></div>
119+
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html_a03c0d39e0167f8a8e7c41f09d19d2861"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html#a03c0d39e0167f8a8e7c41f09d19d2861">ace_routine::ClockInterface::seconds</a></div><div class="ttdeci">static unsigned long seconds()</div><div class="ttdoc">Get the current seconds.</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00063">ClockInterface.h:63</a></div></div>
122120
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html_ab8963dc53edb04d3ab800eac7c3b358e"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html#ab8963dc53edb04d3ab800eac7c3b358e">ace_routine::ClockInterface::micros</a></div><div class="ttdeci">static unsigned long micros()</div><div class="ttdoc">Get the current micros.</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00046">ClockInterface.h:46</a></div></div>
121+
<div class="ttc" id="aclassace__routine_1_1ClockInterface_html_aeb6701bd63ee8fb7dbb81efaf0ac02bf"><div class="ttname"><a href="classace__routine_1_1ClockInterface.html#aeb6701bd63ee8fb7dbb81efaf0ac02bf">ace_routine::ClockInterface::millis</a></div><div class="ttdeci">static unsigned long millis()</div><div class="ttdoc">Get the current millis.</div><div class="ttdef"><b>Definition:</b> <a href="ClockInterface_8h_source.html#l00043">ClockInterface.h:43</a></div></div>
122+
</div><!-- fragment --></div><!-- contents -->
123123
<!-- start footer part -->
124124
<hr class="footer"/><address class="footer"><small>
125-
Generated by &#160;<a href="http://www.doxygen.org/index.html">
126-
<img class="footer" src="doxygen.png" alt="doxygen"/>
127-
</a> 1.8.17
125+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
128126
</small></address>
129127
</body>
130128
</html>

0 commit comments

Comments
 (0)