Skip to content

Commit

Permalink
librishka/runtime.h header file documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Mar 4, 2024
1 parent 158b1c1 commit 474fc2b
Show file tree
Hide file tree
Showing 16 changed files with 172 additions and 22 deletions.
3 changes: 2 additions & 1 deletion docs/dir_6e8afc538eccbcb491711fd0cc7b9703.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="memory_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory_8h.html">memory.h</a></td></tr>
<tr class="memdesc:memory_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header file for memory management in Rishka applications. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="runtime_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><b>runtime.h</b></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="runtime_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="runtime_8h.html">runtime.h</a></td></tr>
<tr class="memdesc:runtime_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides utilities for managing runtime operations within Rishka applications. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="spi_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="spi_8h.html">spi.h</a></td></tr>
<tr class="memdesc:spi_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header file for <a class="el" href="class_s_p_i.html" title="Class for handling SPI communication in Rishka applications.">SPI</a> (Serial Peripheral Interface) communication in Rishka applications. <br /></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/dir_6e8afc538eccbcb491711fd0cc7b9703.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ var dir_6e8afc538eccbcb491711fd0cc7b9703 =
[ "int.h", "int_8h.html", "int_8h" ],
[ "io.h", "io_8h.html", "io_8h" ],
[ "memory.h", "memory_8h.html", "memory_8h" ],
[ "runtime.h", "runtime_8h_source.html", null ],
[ "runtime.h", "runtime_8h.html", "runtime_8h" ],
[ "spi.h", "spi_8h.html", "spi_8h" ],
[ "sys.h", "sys_8h.html", "sys_8h" ],
[ "types.h", "types_8h.html", "types_8h" ]
Expand Down
1 change: 1 addition & 0 deletions docs/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
<a href="int_8h.html"/>
<a href="io_8h.html"/>
<a href="memory_8h.html"/>
<a href="runtime_8h.html"/>
<a href="spi_8h.html"/>
<a href="sys_8h.html"/>
<a href="types_8h.html"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="int_8h_source.html"><span class="icondoc"></span></a><a class="el" href="int_8h.html" target="_self">int.h</a></td><td class="desc">Header file for interrupt handling in Rishka applications </td></tr>
<tr id="row_0_0_5_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="io_8h_source.html"><span class="icondoc"></span></a><a class="el" href="io_8h.html" target="_self">io.h</a></td><td class="desc">Header file for input/output operations in Rishka applications </td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="memory_8h_source.html"><span class="icondoc"></span></a><a class="el" href="memory_8h.html" target="_self">memory.h</a></td><td class="desc">Header file for memory management in Rishka applications </td></tr>
<tr id="row_0_0_7_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="runtime_8h_source.html"><span class="icondoc"></span></a><b>runtime.h</b></td><td class="desc"></td></tr>
<tr id="row_0_0_7_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="runtime_8h_source.html"><span class="icondoc"></span></a><a class="el" href="runtime_8h.html" target="_self">runtime.h</a></td><td class="desc">Provides utilities for managing runtime operations within Rishka applications </td></tr>
<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="spi_8h_source.html"><span class="icondoc"></span></a><a class="el" href="spi_8h.html" target="_self">spi.h</a></td><td class="desc">Header file for <a class="el" href="class_s_p_i.html" title="Class for handling SPI communication in Rishka applications.">SPI</a> (Serial Peripheral Interface) communication in Rishka applications </td></tr>
<tr id="row_0_0_9_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="sys_8h_source.html"><span class="icondoc"></span></a><a class="el" href="sys_8h.html" target="_self">sys.h</a></td><td class="desc">Header file for system utilities in Rishka applications </td></tr>
<tr id="row_0_0_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="types_8h_source.html"><span class="icondoc"></span></a><a class="el" href="types_8h.html" target="_self">types.h</a></td><td class="desc">Header file for common data types used in Rishka applications </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/librishka_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
<code>#include &lt;<a class="el" href="int_8h_source.html">librishka/int.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="io_8h_source.html">librishka/io.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="memory_8h_source.html">librishka/memory.h</a>&gt;</code><br />
<code>#include &lt;librishka/runtime.h&gt;</code><br />
<code>#include &lt;<a class="el" href="runtime_8h_source.html">librishka/runtime.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="spi_8h_source.html">librishka/spi.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="sys_8h_source.html">librishka/sys.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="types_8h_source.html">librishka/types.h</a>&gt;</code><br />
Expand Down
3 changes: 2 additions & 1 deletion docs/librishka_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#include &lt;<a class="code" href="int_8h.html">librishka/int.h</a>&gt;</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#include &lt;<a class="code" href="io_8h.html">librishka/io.h</a>&gt;</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#include &lt;<a class="code" href="memory_8h.html">librishka/memory.h</a>&gt;</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#include &lt;librishka/runtime.h&gt;</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#include &lt;<a class="code" href="runtime_8h.html">librishka/runtime.h</a>&gt;</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#include &lt;<a class="code" href="spi_8h.html">librishka/spi.h</a>&gt;</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#include &lt;<a class="code" href="sys_8h.html">librishka/sys.h</a>&gt;</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#include &lt;<a class="code" href="types_8h.html">librishka/types.h</a>&gt;</span> </div>
Expand All @@ -141,6 +141,7 @@
<div class="ttc" id="aint_8h_html"><div class="ttname"><a href="int_8h.html">int.h</a></div><div class="ttdoc">Header file for interrupt handling in Rishka applications.</div></div>
<div class="ttc" id="aio_8h_html"><div class="ttname"><a href="io_8h.html">io.h</a></div><div class="ttdoc">Header file for input/output operations in Rishka applications.</div></div>
<div class="ttc" id="amemory_8h_html"><div class="ttname"><a href="memory_8h.html">memory.h</a></div><div class="ttdoc">Header file for memory management in Rishka applications.</div></div>
<div class="ttc" id="aruntime_8h_html"><div class="ttname"><a href="runtime_8h.html">runtime.h</a></div><div class="ttdoc">Provides utilities for managing runtime operations within Rishka applications.</div></div>
<div class="ttc" id="aspi_8h_html"><div class="ttname"><a href="spi_8h.html">spi.h</a></div><div class="ttdoc">Header file for SPI (Serial Peripheral Interface) communication in Rishka applications.</div></div>
<div class="ttc" id="asys_8h_html"><div class="ttname"><a href="sys_8h.html">sys.h</a></div><div class="ttdoc">Header file for system utilities in Rishka applications.</div></div>
<div class="ttc" id="atypes_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">Header file for common data types used in Rishka applications.</div></div>
Expand Down
1 change: 1 addition & 0 deletions docs/navtreeindex0.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ var NAVTREEINDEX0 =
"memory_8h.html":[4,0,0,0,6],
"memory_8h_source.html":[4,0,0,0,6],
"pages.html":[],
"runtime_8h.html":[4,0,0,0,7],
"runtime_8h_source.html":[4,0,0,0,7],
"spi_8h.html":[4,0,0,0,8],
"spi_8h.html#ac4b206a51636d91c5cffcbcee458c3cb":[4,0,0,0,8,1],
Expand Down
124 changes: 124 additions & 0 deletions docs/runtime_8h.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Rishka: sdk/librishka/runtime.h File Reference</title>
<link rel="icon" href="rishka-logo.ico" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="rishka-logo.png"/></td>
<td id="projectalign">
<div id="projectname">Rishka
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('runtime_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle"><div class="title">runtime.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Provides utilities for managing runtime operations within Rishka applications.
<a href="#details">More...</a></p>

<p><a href="runtime_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_runtime.html">Runtime</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class provides utilities for managing runtime operations. <a href="class_runtime.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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>Provides utilities for managing runtime operations within Rishka applications. </p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/nthnn">Nathanne Isip</a> </dd></dl>
<p>The <a class="el" href="class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management. Developers can leverage the <a class="el" href="class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class to orchestrate the execution flow of their applications, ensuring efficient utilization of system resources and optimal performance. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="footer">Copyright 2024 - <a href="https://github.com/nthnn" target="_blank">Nathanne Isip</a></li>
</ul>
</div>
4 changes: 4 additions & 0 deletions docs/runtime_8h.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
var runtime_8h =
[
[ "Runtime", "class_runtime.html", null ]
];
Loading

0 comments on commit 474fc2b

Please sign in to comment.