Skip to content

Commit

Permalink
Updated documentation pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nthnn
nthnn committed Apr 15, 2024
1 parent c31a16e commit 935b6a5
Show file tree
Hide file tree
Showing 16 changed files with 186 additions and 266 deletions.
7 changes: 3 additions & 4 deletions docs/d1/d56/classIO-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,9 @@
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#af67b36507b53221d03a5b7f1fd6638f0">print</a>(const string text)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a30f60dd764ba3cb47b19849297dbb7d5">print</a>(i64 number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a60ac760446a47d3e1926ffe0120ff854">print</a>(double number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a45dfb01a4ebfa134227a51f7be20d214">read</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#abd2fd0dfb704cad591e256cb8074f5b2">readch</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a9d4ca0746e40c8b8f37c1c06c3c5d411">readline</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#ac77c1571a9789636cc913425bb235bd4">set_timeout</a>(u64 timeout)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#abd2fd0dfb704cad591e256cb8074f5b2">readch</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a9d4ca0746e40c8b8f37c1c06c3c5d411">readline</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#ac77c1571a9789636cc913425bb235bd4">set_timeout</a>(u64 timeout)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
2 changes: 1 addition & 1 deletion docs/d3/d51/runtime_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif </span><span class="comment">/* LIBRISHKA_RUNTIME_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassRuntime_html"><div class="ttname"><a href="../../d6/dd8/classRuntime.html">Runtime</a></div><div class="ttdoc">The Runtime class provides utilities for managing runtime operations.</div><div class="ttdef"><b>Definition:</b> runtime.h:40</div></div>
<div class="ttc" id="aclassRuntime_html_a8bb09010afe5ea0792d9a0f337c721e7"><div class="ttname"><a href="../../d6/dd8/classRuntime.html#a8bb09010afe5ea0792d9a0f337c721e7">Runtime::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Yield the execution context to other tasks or threads.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:565</div></div>
<div class="ttc" id="aclassRuntime_html_a8bb09010afe5ea0792d9a0f337c721e7"><div class="ttname"><a href="../../d6/dd8/classRuntime.html#a8bb09010afe5ea0792d9a0f337c721e7">Runtime::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Yield the execution context to other tasks or threads.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:560</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
8 changes: 4 additions & 4 deletions docs/d3/d7e/int_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif </span><span class="comment">/* LIBRISHKA_INT_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclassInt_html"><div class="ttname"><a href="../../d8/d2f/classInt.html">Int</a></div><div class="ttdoc">Class for handling interrupt operations in Rishka applications.</div><div class="ttdef"><b>Definition:</b> int.h:54</div></div>
<div class="ttc" id="aclassInt_html_a48e45db27a68cd8f61599fc7a8682d9c"><div class="ttname"><a href="../../d8/d2f/classInt.html#a48e45db27a68cd8f61599fc7a8682d9c">Int::detach</a></div><div class="ttdeci">static void detach(u8 pin)</div><div class="ttdoc">Detach the interrupt handler from a GPIO pin.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:369</div></div>
<div class="ttc" id="aclassInt_html_a68ab519107cb53ab894235d0dd417f2d"><div class="ttname"><a href="../../d8/d2f/classInt.html#a68ab519107cb53ab894235d0dd417f2d">Int::disable</a></div><div class="ttdeci">static void disable()</div><div class="ttdoc">Disable interrupts globally.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:361</div></div>
<div class="ttc" id="aclassInt_html_a7aaa4897b7573393edfc570befc20fa2"><div class="ttname"><a href="../../d8/d2f/classInt.html#a7aaa4897b7573393edfc570befc20fa2">Int::attach</a></div><div class="ttdeci">static void attach(u8 pin, void(*callback)(void), int_mode_t mode)</div><div class="ttdoc">Attach an interrupt handler to a GPIO pin.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:365</div></div>
<div class="ttc" id="aclassInt_html_af4185f9eb3464dac93a1ce84d0ec907b"><div class="ttname"><a href="../../d8/d2f/classInt.html#af4185f9eb3464dac93a1ce84d0ec907b">Int::enable</a></div><div class="ttdeci">static void enable()</div><div class="ttdoc">Enable interrupts globally.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:357</div></div>
<div class="ttc" id="aclassInt_html_a48e45db27a68cd8f61599fc7a8682d9c"><div class="ttname"><a href="../../d8/d2f/classInt.html#a48e45db27a68cd8f61599fc7a8682d9c">Int::detach</a></div><div class="ttdeci">static void detach(u8 pin)</div><div class="ttdoc">Detach the interrupt handler from a GPIO pin.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:364</div></div>
<div class="ttc" id="aclassInt_html_a68ab519107cb53ab894235d0dd417f2d"><div class="ttname"><a href="../../d8/d2f/classInt.html#a68ab519107cb53ab894235d0dd417f2d">Int::disable</a></div><div class="ttdeci">static void disable()</div><div class="ttdoc">Disable interrupts globally.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:356</div></div>
<div class="ttc" id="aclassInt_html_a7aaa4897b7573393edfc570befc20fa2"><div class="ttname"><a href="../../d8/d2f/classInt.html#a7aaa4897b7573393edfc570befc20fa2">Int::attach</a></div><div class="ttdeci">static void attach(u8 pin, void(*callback)(void), int_mode_t mode)</div><div class="ttdoc">Attach an interrupt handler to a GPIO pin.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:360</div></div>
<div class="ttc" id="aclassInt_html_af4185f9eb3464dac93a1ce84d0ec907b"><div class="ttname"><a href="../../d8/d2f/classInt.html#af4185f9eb3464dac93a1ce84d0ec907b">Int::enable</a></div><div class="ttdeci">static void enable()</div><div class="ttdoc">Enable interrupts globally.</div><div class="ttdef"><b>Definition:</b> librishka_impl.cpp:352</div></div>
<div class="ttc" id="aint_8h_html_a8c5d45f0ae61660e0c81111397dbbae6"><div class="ttname"><a href="../../d3/d7e/int_8h.html#a8c5d45f0ae61660e0c81111397dbbae6">int_mode_t</a></div><div class="ttdeci">int_mode_t</div><div class="ttdoc">Enum representing interrupt modes for GPIO pins.</div><div class="ttdef"><b>Definition:</b> int.h:40</div></div>
<div class="ttc" id="aint_8h_html_a8c5d45f0ae61660e0c81111397dbbae6a3a9f764a735d3c1e28a079a8fa7a44b9"><div class="ttname"><a href="../../d3/d7e/int_8h.html#a8c5d45f0ae61660e0c81111397dbbae6a3a9f764a735d3c1e28a079a8fa7a44b9">INT_CHANGE</a></div><div class="ttdeci">@ INT_CHANGE</div><div class="ttdef"><b>Definition:</b> int.h:41</div></div>
<div class="ttc" id="aint_8h_html_a8c5d45f0ae61660e0c81111397dbbae6a594b9c1e1f3eba9e45d1b75d12e4800d"><div class="ttname"><a href="../../d3/d7e/int_8h.html#a8c5d45f0ae61660e0c81111397dbbae6a594b9c1e1f3eba9e45d1b75d12e4800d">INT_RISING</a></div><div class="ttdeci">@ INT_RISING</div><div class="ttdef"><b>Definition:</b> int.h:43</div></div>
Expand Down
Loading

0 comments on commit 935b6a5

Please sign in to comment.