Skip to content

Commit

Permalink
Updated SDK documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Apr 10, 2024
1 parent d22b0a8 commit 357086c
Show file tree
Hide file tree
Showing 18 changed files with 221 additions and 134 deletions.
71 changes: 71 additions & 0 deletions docs/d0/d04/class_sys.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,53 @@
<tr class="memitem:a3cc8c3d6432a431ea7655ddc272d2531"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a6c95997324761b0f5e6aa06244f52d24">i64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d04/class_sys.html#a3cc8c3d6432a431ea7655ddc272d2531">random</a> ()</td></tr>
<tr class="memdesc:a3cc8c3d6432a431ea7655ddc272d2531"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random integer value. <br /></td></tr>
<tr class="separator:a3cc8c3d6432a431ea7655ddc272d2531"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc14702959528aa2c6abb0ac3771a68b"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d04/class_sys.html#abc14702959528aa2c6abb0ac3771a68b">changeDirectory</a> (char *directory)</td></tr>
<tr class="memdesc:abc14702959528aa2c6abb0ac3771a68b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the current working directory. <br /></td></tr>
<tr class="separator:abc14702959528aa2c6abb0ac3771a68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4fea3e1d3b60392b30b78eb5b35e446"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d04/class_sys.html#ac4fea3e1d3b60392b30b78eb5b35e446">workingDirectory</a> ()</td></tr>
<tr class="memdesc:ac4fea3e1d3b60392b30b78eb5b35e446"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the current working directory. <br /></td></tr>
<tr class="separator:ac4fea3e1d3b60392b30b78eb5b35e446"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for handling system utilities in Rishka applications. </p>
<p>The <a class="el" href="../../d0/d04/class_sys.html" title="Class for handling system utilities in Rishka applications.">Sys</a> class provides static methods for delaying execution, accessing system time, executing shell commands, retrieving system information, and exiting the application. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abc14702959528aa2c6abb0ac3771a68b" name="abc14702959528aa2c6abb0ac3771a68b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc14702959528aa2c6abb0ac3771a68b">&#9670;&#160;</a></span>changeDirectory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Sys::changeDirectory </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>directory</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Changes the current working directory. </p>
<p>This static method changes the current working directory to the specified directory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">directory</td><td>The directory to change to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the directory change was successful, false otherwise. </dd></dl>

</div>
</div>
<a id="a9418655c63dd6022b504993d73b11cc5" name="a9418655c63dd6022b504993d73b11cc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9418655c63dd6022b504993d73b11cc5">&#9670;&#160;</a></span>delay()</h2>

Expand Down Expand Up @@ -416,6 +458,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#abb99002ebc9b4b1edd2491d7
</dl>
<dl class="section return"><dt>Returns</dt><dd>The exit status of the shell command. </dd></dl>

</div>
</div>
<a id="ac4fea3e1d3b60392b30b78eb5b35e446" name="ac4fea3e1d3b60392b30b78eb5b35e446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4fea3e1d3b60392b30b78eb5b35e446">&#9670;&#160;</a></span>workingDirectory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> Sys::workingDirectory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Retrieves the current working directory. </p>
<p>This static method returns the current working directory as a string.</p>
<dl class="section return"><dt>Returns</dt><dd>A string representing the current working directory. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/d3/d51/runtime_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,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="aclass_runtime_html"><div class="ttname"><a href="../../d3/df6/class_runtime.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="aclass_runtime_html_a8bb09010afe5ea0792d9a0f337c721e7"><div class="ttname"><a href="../../d3/df6/class_runtime.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:655</div></div>
<div class="ttc" id="aclass_runtime_html_a8bb09010afe5ea0792d9a0f337c721e7"><div class="ttname"><a href="../../d3/df6/class_runtime.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:666</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
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,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="aclass_int_html"><div class="ttname"><a href="../../d8/dec/class_int.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="aclass_int_html_a48e45db27a68cd8f61599fc7a8682d9c"><div class="ttname"><a href="../../d8/dec/class_int.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:379</div></div>
<div class="ttc" id="aclass_int_html_a68ab519107cb53ab894235d0dd417f2d"><div class="ttname"><a href="../../d8/dec/class_int.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:371</div></div>
<div class="ttc" id="aclass_int_html_a7aaa4897b7573393edfc570befc20fa2"><div class="ttname"><a href="../../d8/dec/class_int.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:375</div></div>
<div class="ttc" id="aclass_int_html_af4185f9eb3464dac93a1ce84d0ec907b"><div class="ttname"><a href="../../d8/dec/class_int.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:367</div></div>
<div class="ttc" id="aclass_int_html_a48e45db27a68cd8f61599fc7a8682d9c"><div class="ttname"><a href="../../d8/dec/class_int.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:390</div></div>
<div class="ttc" id="aclass_int_html_a68ab519107cb53ab894235d0dd417f2d"><div class="ttname"><a href="../../d8/dec/class_int.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:382</div></div>
<div class="ttc" id="aclass_int_html_a7aaa4897b7573393edfc570befc20fa2"><div class="ttname"><a href="../../d8/dec/class_int.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:386</div></div>
<div class="ttc" id="aclass_int_html_af4185f9eb3464dac93a1ce84d0ec907b"><div class="ttname"><a href="../../d8/dec/class_int.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:378</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
18 changes: 10 additions & 8 deletions docs/d4/de5/class_sys-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,16 @@

<p>This is the complete list of members for <a class="el" href="../../d0/d04/class_sys.html">Sys</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a9418655c63dd6022b504993d73b11cc5">delay</a>(u64 ms)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a37cb3000f2181139f80d856a5ee4577e">exit</a>(i32 code)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#af9f480514351655ace2256653f1d7529">info_num</a>(sysinfon_t key)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a44fe8ecbb8edf7afa0dfcfedbbd645b5">info_str</a>(sysinfos_t key)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a9e9083c9abd766d90ae71ae9ba6bc28b">micros</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#acfe1b7f4ea18cb985d2465d4f9bbebd3">millis</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a3cc8c3d6432a431ea7655ddc272d2531">random</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#abb99002ebc9b4b1edd2491d776eed1dc">shellexec</a>(string program, i32 argc, string *argv)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#abc14702959528aa2c6abb0ac3771a68b">changeDirectory</a>(char *directory)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a9418655c63dd6022b504993d73b11cc5">delay</a>(u64 ms)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a37cb3000f2181139f80d856a5ee4577e">exit</a>(i32 code)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#af9f480514351655ace2256653f1d7529">info_num</a>(sysinfon_t key)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a44fe8ecbb8edf7afa0dfcfedbbd645b5">info_str</a>(sysinfos_t key)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a9e9083c9abd766d90ae71ae9ba6bc28b">micros</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#acfe1b7f4ea18cb985d2465d4f9bbebd3">millis</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#a3cc8c3d6432a431ea7655ddc272d2531">random</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#abb99002ebc9b4b1edd2491d776eed1dc">shellexec</a>(string program, i32 argc, string *argv)</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d0/d04/class_sys.html#ac4fea3e1d3b60392b30b78eb5b35e446">workingDirectory</a>()</td><td class="entry"><a class="el" href="../../d0/d04/class_sys.html">Sys</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
Loading

0 comments on commit 357086c

Please sign in to comment.