Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@amateomi
amateomi committed Jul 6, 2022
1 parent e1582fd commit 77ab399
Show file tree
Hide file tree
Showing 203 changed files with 15,164 additions and 0 deletions.
2,658 changes: 2,658 additions & 0 deletions Doxyfile
View file

Large diffs are not rendered by default.

82 changes: 82 additions & 0 deletions docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<!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">
<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.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Karashi: Class List</title>
<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>
<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" />
</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="projectalign">
<div id="projectname">Karashi<span id="projectnumber">&#160;0.1.1</span>
</div>
<div id="projectbrief">Kara is basic Linux shell, indeed</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<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="structAbstractSyntaxTree.html" target="_self">AbstractSyntaxTree</a></td><td class="desc">Array of <a class="el" href="structCommand.html" title="Single command to execute.">Command</a> structures, each command is piped to next one </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="structCommand.html" target="_self">Command</a></td><td class="desc">Single command to execute </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="structTokens.html" target="_self">Tokens</a></td><td class="desc">Array of tokens </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>
Binary file added docs/html/bc_s.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/bdwn.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
186 changes: 186 additions & 0 deletions docs/html/built-in_8c.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
<!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">
<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.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Karashi: src/built-in.c File Reference</title>
<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>
<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" />
</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="projectalign">
<div id="projectname">Karashi<span id="projectnumber">&#160;0.1.1</span>
</div>
<div id="projectbrief">Kara is basic Linux shell, indeed</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">built-in.c File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Contents shell built-in commands table.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="built-in_8h_source.html">built-in.h</a>&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a87c9dde477023307eb0245984d0546e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="built-in_8c.html#a87c9dde477023307eb0245984d0546e7">COMMAND_MAX_LEN</a>&#160;&#160;&#160;8</td></tr>
<tr class="memdesc:a87c9dde477023307eb0245984d0546e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defining the maximum length of a command. <a href="built-in_8c.html#a87c9dde477023307eb0245984d0546e7">More...</a><br /></td></tr>
<tr class="separator:a87c9dde477023307eb0245984d0546e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a88152b1474b35a9be103d431a9357480"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="built-in_8c.html#a88152b1474b35a9be103d431a9357480">is_in_table</a> (const char string[])</td></tr>
<tr class="memdesc:a88152b1474b35a9be103d431a9357480"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if string is built-in command. <a href="built-in_8c.html#a88152b1474b35a9be103d431a9357480">More...</a><br /></td></tr>
<tr class="separator:a88152b1474b35a9be103d431a9357480"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a8991d68172598327500cdc8f0fd7ef00"><td class="memItemLeft" align="right" valign="top">static const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="built-in_8c.html#a8991d68172598327500cdc8f0fd7ef00">TABLE</a> [][<a class="el" href="built-in_8c.html#a87c9dde477023307eb0245984d0546e7">COMMAND_MAX_LEN</a>]</td></tr>
<tr class="memdesc:a8991d68172598327500cdc8f0fd7ef00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Table of built-in commands. <a href="built-in_8c.html#a8991d68172598327500cdc8f0fd7ef00">More...</a><br /></td></tr>
<tr class="separator:a8991d68172598327500cdc8f0fd7ef00"><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 >Contents shell built-in commands table. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a87c9dde477023307eb0245984d0546e7" name="a87c9dde477023307eb0245984d0546e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87c9dde477023307eb0245984d0546e7">&#9670;&nbsp;</a></span>COMMAND_MAX_LEN</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMAND_MAX_LEN&#160;&#160;&#160;8</td>
</tr>
</table>
</div><div class="memdoc">

<p>Defining the maximum length of a command. </p>
<p >C programming language forbid to define arrays with two empty square brackets (table[][] is not allowed), so we must determine some arbitrary number to use in TABLE. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a88152b1474b35a9be103d431a9357480" name="a88152b1474b35a9be103d431a9357480"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88152b1474b35a9be103d431a9357480">&#9670;&nbsp;</a></span>is_in_table()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool is_in_table </td>
<td>(</td>
<td class="paramtype">const char&#160;</td>
<td class="paramname"><em>string</em>[]</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Determine if string is built-in command. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>The string to check.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the string is in the table, and false otherwise. </dd></dl>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a8991d68172598327500cdc8f0fd7ef00" name="a8991d68172598327500cdc8f0fd7ef00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8991d68172598327500cdc8f0fd7ef00">&#9670;&nbsp;</a></span>TABLE</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char TABLE[][<a class="el" href="built-in_8c.html#a87c9dde477023307eb0245984d0546e7">COMMAND_MAX_LEN</a>]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> <a class="code hl_define" href="built-in_8h.html#a1050140a3d78b059f809a424e0d9e1c7">CD</a>,</div>
<div class="line"> <a class="code hl_define" href="built-in_8h.html#ad111e603bbebe5d87f6bc39264ce4733">EXIT</a></div>
<div class="line">}</div>
<div class="ttc" id="abuilt-in_8h_html_a1050140a3d78b059f809a424e0d9e1c7"><div class="ttname"><a href="built-in_8h.html#a1050140a3d78b059f809a424e0d9e1c7">CD</a></div><div class="ttdeci">#define CD</div><div class="ttdoc">Change current working directory.</div><div class="ttdef"><b>Definition:</b> built-in.h:31</div></div>
<div class="ttc" id="abuilt-in_8h_html_ad111e603bbebe5d87f6bc39264ce4733"><div class="ttname"><a href="built-in_8h.html#ad111e603bbebe5d87f6bc39264ce4733">EXIT</a></div><div class="ttdeci">#define EXIT</div><div class="ttdoc">Quit shell.</div><div class="ttdef"><b>Definition:</b> built-in.h:32</div></div>
</div><!-- fragment -->
<p>Table of built-in commands. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>
Loading

0 comments on commit 77ab399

Please sign in to comment.