Skip to content

Commit 3ad40ed

Browse files
committed
docs: Regenerate doxygen docs for v1.1
1 parent 7ec042e commit 3ad40ed

File tree

160 files changed

+841
-6391
lines changed

Some content is hidden

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

160 files changed

+841
-6391
lines changed

docs/html/AceRoutine_8h_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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.1</span>
25+
&#160;<span id="projectnumber">1.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>
@@ -103,8 +103,8 @@
103103
<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>
104104
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
105105
<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>
106+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10100</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.1&quot;</span></div>
108108
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
109109
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
110110
</div><!-- fragment --></div><!-- contents -->

docs/html/Channel_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.1</span>
25+
&#160;<span id="projectnumber">1.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>

docs/html/CommandDispatcher_8cpp_source.html

Lines changed: 0 additions & 232 deletions
This file was deleted.

docs/html/CommandDispatcher_8h_source.html

Lines changed: 0 additions & 240 deletions
This file was deleted.

docs/html/CommandHandler_8h_source.html

Lines changed: 0 additions & 163 deletions
This file was deleted.

docs/html/CommandManager_8h_source.html

Lines changed: 0 additions & 165 deletions
This file was deleted.

docs/html/CoroutineScheduler_8cpp_source.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -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.1</span>
25+
&#160;<span id="projectnumber">1.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>
@@ -186,7 +186,7 @@
186186
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">for</span> (Coroutine** p = <a class="code" href="classace__routine_1_1Coroutine.html#a8a2a6d50806df1706eb313aea17ce45e">Coroutine::getRoot</a>(); (*p) != <span class="keyword">nullptr</span>;</div>
187187
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; p = (*p)-&gt;<a class="code" href="classace__routine_1_1Coroutine.html#abac7ce4542f9a27462b35fb9d92151d8">getNext</a>()) {</div>
188188
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; printer.print(F(<span class="stringliteral">&quot;Coroutine &quot;</span>));</div>
189-
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; (*p)-&gt;<a class="code" href="classace__routine_1_1Coroutine.html#ac3ae9a51f27913228607b865cc76b530">getName</a>().<a class="code" href="classace__routine_1_1FCString.html#a834801808fbe4c5b7a8af27cca07732b">printTo</a>(printer);</div>
189+
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; (*p)-&gt;<a class="code" href="classace__routine_1_1Coroutine.html#a6ee1f35bacffebf86c79c22a62fa8891">getName</a>().printTo(printer);</div>
190190
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; printer.print(F(<span class="stringliteral">&quot;; status: &quot;</span>));</div>
191191
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; (*p)-&gt;statusPrintTo(printer);</div>
192192
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; printer.println();</div>
@@ -195,14 +195,13 @@
195195
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
196196
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;}</div>
197197
</div><!-- fragment --></div><!-- contents -->
198-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_ac3ae9a51f27913228607b865cc76b530"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#ac3ae9a51f27913228607b865cc76b530">ace_routine::Coroutine::getName</a></div><div class="ttdeci">const FCString &amp; getName() const</div><div class="ttdoc">Human-readable name of the coroutine.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00275">Coroutine.h:275</a></div></div>
199-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a397f0d87d99b538189353fa47e918022"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a397f0d87d99b538189353fa47e918022">ace_routine::Coroutine::kStatusSuspended</a></div><div class="ttdeci">static const Status kStatusSuspended</div><div class="ttdoc">Coroutine has been suspended using suspend() and the scheduler should remove it from the queue upon t...</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00467">Coroutine.h:467</a></div></div>
200-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_abac7ce4542f9a27462b35fb9d92151d8"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#abac7ce4542f9a27462b35fb9d92151d8">ace_routine::Coroutine::getNext</a></div><div class="ttdeci">Coroutine ** getNext()</div><div class="ttdoc">Return the next pointer as a pointer to the pointer, similar to getRoot().</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00272">Coroutine.h:272</a></div></div>
201-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a991b8a3e15ea272d906ab7ccf09ca56a"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a991b8a3e15ea272d906ab7ccf09ca56a">ace_routine::Coroutine::kStatusEnding</a></div><div class="ttdeci">static const Status kStatusEnding</div><div class="ttdoc">Coroutine executed the COROUTINE_END() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00479">Coroutine.h:479</a></div></div>
202-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a180062205c19934c2791c4185cbe0968"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a180062205c19934c2791c4185cbe0968">ace_routine::Coroutine::kStatusDelaying</a></div><div class="ttdeci">static const Status kStatusDelaying</div><div class="ttdoc">Coroutine returned using the COROUTINE_DELAY() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00473">Coroutine.h:473</a></div></div>
203-
<div class="ttc" id="aclassace__routine_1_1FCString_html_a834801808fbe4c5b7a8af27cca07732b"><div class="ttname"><a href="classace__routine_1_1FCString.html#a834801808fbe4c5b7a8af27cca07732b">ace_routine::FCString::printTo</a></div><div class="ttdeci">size_t printTo(Print &amp;printer) const</div><div class="ttdoc">Convenience method for printing an FCString to printer.</div><div class="ttdef"><b>Definition:</b> <a href="FCString_8cpp_source.html#l00035">FCString.cpp:35</a></div></div>
204-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a44536673988682d943524d28d260f42e"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a44536673988682d943524d28d260f42e">ace_routine::Coroutine::kStatusYielding</a></div><div class="ttdeci">static const Status kStatusYielding</div><div class="ttdoc">Coroutine returned using the COROUTINE_YIELD() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00470">Coroutine.h:470</a></div></div>
205-
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a8a2a6d50806df1706eb313aea17ce45e"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a8a2a6d50806df1706eb313aea17ce45e">ace_routine::Coroutine::getRoot</a></div><div class="ttdeci">static Coroutine ** getRoot()</div><div class="ttdoc">Get the pointer to the root pointer.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8cpp_source.html#l00034">Coroutine.cpp:34</a></div></div>
198+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a397f0d87d99b538189353fa47e918022"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a397f0d87d99b538189353fa47e918022">ace_routine::Coroutine::kStatusSuspended</a></div><div class="ttdeci">static const Status kStatusSuspended</div><div class="ttdoc">Coroutine has been suspended using suspend() and the scheduler should remove it from the queue upon t...</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00477">Coroutine.h:477</a></div></div>
199+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_abac7ce4542f9a27462b35fb9d92151d8"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#abac7ce4542f9a27462b35fb9d92151d8">ace_routine::Coroutine::getNext</a></div><div class="ttdeci">Coroutine ** getNext()</div><div class="ttdoc">Return the next pointer as a pointer to the pointer, similar to getRoot().</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00264">Coroutine.h:264</a></div></div>
200+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a991b8a3e15ea272d906ab7ccf09ca56a"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a991b8a3e15ea272d906ab7ccf09ca56a">ace_routine::Coroutine::kStatusEnding</a></div><div class="ttdeci">static const Status kStatusEnding</div><div class="ttdoc">Coroutine executed the COROUTINE_END() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00489">Coroutine.h:489</a></div></div>
201+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a6ee1f35bacffebf86c79c22a62fa8891"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a6ee1f35bacffebf86c79c22a62fa8891">ace_routine::Coroutine::getName</a></div><div class="ttdeci">const ace_common::FCString &amp; getName() const</div><div class="ttdoc">Human-readable name of the coroutine.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00267">Coroutine.h:267</a></div></div>
202+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a180062205c19934c2791c4185cbe0968"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a180062205c19934c2791c4185cbe0968">ace_routine::Coroutine::kStatusDelaying</a></div><div class="ttdeci">static const Status kStatusDelaying</div><div class="ttdoc">Coroutine returned using the COROUTINE_DELAY() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00483">Coroutine.h:483</a></div></div>
203+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a44536673988682d943524d28d260f42e"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a44536673988682d943524d28d260f42e">ace_routine::Coroutine::kStatusYielding</a></div><div class="ttdeci">static const Status kStatusYielding</div><div class="ttdoc">Coroutine returned using the COROUTINE_YIELD() statement.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00480">Coroutine.h:480</a></div></div>
204+
<div class="ttc" id="aclassace__routine_1_1Coroutine_html_a8a2a6d50806df1706eb313aea17ce45e"><div class="ttname"><a href="classace__routine_1_1Coroutine.html#a8a2a6d50806df1706eb313aea17ce45e">ace_routine::Coroutine::getRoot</a></div><div class="ttdeci">static Coroutine ** getRoot()</div><div class="ttdoc">Get the pointer to the root pointer.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8cpp_source.html#l00035">Coroutine.cpp:35</a></div></div>
206205
<!-- start footer part -->
207206
<hr class="footer"/><address class="footer"><small>
208207
Generated by &#160;<a href="http://www.doxygen.org/index.html">

docs/html/CoroutineScheduler_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.1</span>
25+
&#160;<span id="projectnumber">1.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>

0 commit comments

Comments
 (0)