Skip to content

Commit

Permalink
Updated Doxygen documentation pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Apr 14, 2024
1 parent 159ecff commit 9d0670c
Show file tree
Hide file tree
Showing 218 changed files with 10,666 additions and 2,442 deletions.
42 changes: 17 additions & 25 deletions docs/annotated.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!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">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.7"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Rishka: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -36,10 +36,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -79,16 +79,9 @@

<!-- 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>
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
Expand All @@ -97,17 +90,16 @@
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dc/dc6/class_args.html" target="_self">Args</a></td><td class="desc">Class for handling command line arguments in Rishka applications </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d1/d31/class_file.html" target="_self">File</a></td><td class="desc">Class for handling file operations in Rishka applications </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d3/da6/class_f_s.html" target="_self">FS</a></td><td class="desc">Class for file system operations in Rishka applications </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d1/dea/class_gpio.html" target="_self">Gpio</a></td><td class="desc">Class for handling GPIO operations in Rishka applications </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d47/class_i2_c.html" target="_self">I2C</a></td><td class="desc">Class for handling <a class="el" href="d4/d47/class_i2_c.html" title="Class for handling I2C operations in Rishka applications.">I2C</a> operations in Rishka applications </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d8/dec/class_int.html" target="_self">Int</a></td><td class="desc">Class for handling interrupt operations in Rishka applications </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d8/d24/class_i_o.html" target="_self">IO</a></td><td class="desc">Class for handling input/output operations in Rishka applications </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d2/d01/class_memory.html" target="_self">Memory</a></td><td class="desc">Class for handling memory management operations in Rishka applications </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d3/df6/class_runtime.html" target="_self">Runtime</a></td><td class="desc">Utilities for managing runtime operations </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d3/dfe/class_s_p_i.html" target="_self">SPI</a></td><td class="desc">Class for handling <a class="el" href="d3/dfe/class_s_p_i.html" title="Class for handling SPI communication in Rishka applications.">SPI</a> communication in Rishka applications </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d0/d04/class_sys.html" target="_self">Sys</a></td><td class="desc">Class for handling system utilities in Rishka applications </td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/dfa/classArgs.html" target="_self">Args</a></td><td class="desc">Class for handling command line arguments in Rishka applications </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d30/classFile.html" target="_self">File</a></td><td class="desc">Class for handling file operations in Rishka applications </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d6/df3/classFS.html" target="_self">FS</a></td><td class="desc">Class for file system operations in Rishka applications </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d79/classGpio.html" target="_self">Gpio</a></td><td class="desc">Class for handling GPIO operations in Rishka applications </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d6/d81/classI2C.html" target="_self">I2C</a></td><td class="desc">Class for handling <a class="el" href="d6/d81/classI2C.html" title="Class for handling I2C operations in Rishka applications.">I2C</a> operations in Rishka applications </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d8/d2f/classInt.html" target="_self">Int</a></td><td class="desc">Class for handling interrupt operations in Rishka applications </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d8/d66/classIO.html" target="_self">IO</a></td><td class="desc">Class for handling input/output operations in Rishka applications </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="da/dc6/classMemory.html" target="_self">Memory</a></td><td class="desc">Class for handling memory management operations in Rishka applications </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d6/dd8/classRuntime.html" target="_self">Runtime</a></td><td class="desc">Utilities for managing runtime operations </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d1/d61/classSys.html" target="_self">Sys</a></td><td class="desc">Class for handling system utilities in Rishka applications </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
21 changes: 10 additions & 11 deletions docs/annotated_dup.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
var annotated_dup =
[
[ "Args", "dc/dc6/class_args.html", null ],
[ "File", "d1/d31/class_file.html", "d1/d31/class_file" ],
[ "FS", "d3/da6/class_f_s.html", null ],
[ "Gpio", "d1/dea/class_gpio.html", null ],
[ "I2C", "d4/d47/class_i2_c.html", null ],
[ "Int", "d8/dec/class_int.html", null ],
[ "IO", "d8/d24/class_i_o.html", null ],
[ "Memory", "d2/d01/class_memory.html", null ],
[ "Runtime", "d3/df6/class_runtime.html", null ],
[ "SPI", "d3/dfe/class_s_p_i.html", null ],
[ "Sys", "d0/d04/class_sys.html", null ]
[ "Args", "dd/dfa/classArgs.html", null ],
[ "File", "db/d30/classFile.html", "db/d30/classFile" ],
[ "FS", "d6/df3/classFS.html", null ],
[ "Gpio", "d4/d79/classGpio.html", null ],
[ "I2C", "d6/d81/classI2C.html", null ],
[ "Int", "d8/d2f/classInt.html", null ],
[ "IO", "d8/d66/classIO.html", null ],
[ "Memory", "da/dc6/classMemory.html", null ],
[ "Runtime", "d6/dd8/classRuntime.html", null ],
[ "Sys", "d1/d61/classSys.html", null ]
];
Binary file added docs/bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 14 additions & 21 deletions docs/classes.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!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">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.7"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Rishka: Class Index</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -36,10 +36,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -79,16 +79,9 @@

<!-- 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>
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
Expand All @@ -99,25 +92,25 @@
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a id="letter_A" name="letter_A">A</a></dt>
<dd><a class="el" href="dc/dc6/class_args.html">Args</a></dd></dl>
<dd><a class="el" href="dd/dfa/classArgs.html">Args</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_F" name="letter_F">F</a></dt>
<dd><a class="el" href="d1/d31/class_file.html">File</a></dd><dd><a class="el" href="d3/da6/class_f_s.html">FS</a></dd></dl>
<dd><a class="el" href="db/d30/classFile.html">File</a></dd><dd><a class="el" href="d6/df3/classFS.html">FS</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_G" name="letter_G">G</a></dt>
<dd><a class="el" href="d1/dea/class_gpio.html">Gpio</a></dd></dl>
<dd><a class="el" href="d4/d79/classGpio.html">Gpio</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_I" name="letter_I">I</a></dt>
<dd><a class="el" href="d4/d47/class_i2_c.html">I2C</a></dd><dd><a class="el" href="d8/dec/class_int.html">Int</a></dd><dd><a class="el" href="d8/d24/class_i_o.html">IO</a></dd></dl>
<dd><a class="el" href="d6/d81/classI2C.html">I2C</a></dd><dd><a class="el" href="d8/d2f/classInt.html">Int</a></dd><dd><a class="el" href="d8/d66/classIO.html">IO</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_M" name="letter_M">M</a></dt>
<dd><a class="el" href="d2/d01/class_memory.html">Memory</a></dd></dl>
<dd><a class="el" href="da/dc6/classMemory.html">Memory</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_R" name="letter_R">R</a></dt>
<dd><a class="el" href="d3/df6/class_runtime.html">Runtime</a></dd></dl>
<dd><a class="el" href="d6/dd8/classRuntime.html">Runtime</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
<dd><a class="el" href="d3/dfe/class_s_p_i.html">SPI</a></dd><dd><a class="el" href="d0/d04/class_sys.html">Sys</a></dd></dl>
<dd><a class="el" href="d1/d61/classSys.html">Sys</a></dd></dl>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
Expand Down
Loading

0 comments on commit 9d0670c

Please sign in to comment.