Skip to content

Commit

Permalink
[~] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
toro-nicolas committed May 7, 2024
1 parent bfc278d commit 935db2b
Show file tree
Hide file tree
Showing 279 changed files with 7,992 additions and 5,605 deletions.
6 changes: 6 additions & 0 deletions docs/html/dir_1909b13b6d0cbcc1d36d622424b54e1c.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="else_8c.html">else.c</a></td></tr>
<tr class="memdesc:else_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the else builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="end_8c.html">end.c</a></td></tr>
<tr class="memdesc:end_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the end builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="endif_8c.html">endif.c</a></td></tr>
<tr class="memdesc:endif_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the endif builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -154,6 +157,9 @@
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unalias_8c.html">unalias.c</a></td></tr>
<tr class="memdesc:unalias_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the unalias builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unset_8c.html">unset.c</a></td></tr>
<tr class="memdesc:unset_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the unset builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unsetenv_8c.html">unsetenv.c</a></td></tr>
<tr class="memdesc:unsetenv_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the unsetenv builtin. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down
2 changes: 2 additions & 0 deletions docs/html/dir_1909b13b6d0cbcc1d36d622424b54e1c.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var dir_1909b13b6d0cbcc1d36d622424b54e1c =
[ "cd.c", "cd_8c.html", "cd_8c" ],
[ "echo.c", "echo_8c.html", "echo_8c" ],
[ "else.c", "else_8c.html", "else_8c" ],
[ "end.c", "end_8c.html", "end_8c" ],
[ "endif.c", "endif_8c.html", "endif_8c" ],
[ "env.c", "env_8c.html", "env_8c" ],
[ "exec.c", "exec_8c.html", "exec_8c" ],
Expand All @@ -17,6 +18,7 @@ var dir_1909b13b6d0cbcc1d36d622424b54e1c =
[ "setenv.c", "setenv_8c.html", "setenv_8c" ],
[ "source.c", "source_8c.html", "source_8c" ],
[ "unalias.c", "unalias_8c.html", "unalias_8c" ],
[ "unset.c", "unset_8c.html", "unset_8c" ],
[ "unsetenv.c", "unsetenv_8c.html", "unsetenv_8c" ],
[ "where.c", "where_8c.html", "where_8c" ],
[ "which.c", "which_8c.html", "which_8c" ]
Expand Down
2 changes: 1 addition & 1 deletion docs/html/dir_b6e5a2369341341b7b7f216690b76465.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
<tr class="memdesc:operators_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the operators functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parentheses_8c.html">parentheses.c</a></td></tr>
<tr class="memdesc:parentheses_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="parentheses_8c.html" title="The parentheses.c.">parentheses.c</a>. <br /></td></tr>
<tr class="memdesc:parentheses_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the parentheses functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pipes_8c.html">pipes.c</a></td></tr>
<tr class="memdesc:pipes_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file containing the pipes functions. <br /></td></tr>
Expand Down
2 changes: 2 additions & 0 deletions docs/html/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@
<a href="cd_8c.html"/>
<a href="echo_8c.html"/>
<a href="else_8c.html"/>
<a href="end_8c.html"/>
<a href="endif_8c.html"/>
<a href="env_8c.html"/>
<a href="exec_8c.html"/>
Expand All @@ -212,6 +213,7 @@
<a href="setenv_8c.html"/>
<a href="source_8c.html"/>
<a href="unalias_8c.html"/>
<a href="unset_8c.html"/>
<a href="unsetenv_8c.html"/>
<a href="where_8c.html"/>
<a href="which_8c.html"/>
Expand Down
155 changes: 155 additions & 0 deletions docs/html/end_8c.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>42sh: src/builtins/end.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.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" />
</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">42sh<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Create a shell in C</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(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('end_8c.html',''); initResizable(true); });
/* @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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">end.c File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>The file containing the end builtin.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="myshell_8h_source.html">../../include/myshell.h</a>&quot;</code><br />
</div><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:a7ede9de6e91a986a8f4b32bcfb9e0016" id="r_a7ede9de6e91a986a8f4b32bcfb9e0016"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ede9de6e91a986a8f4b32bcfb9e0016">exec_end</a> (<a class="el" href="structmysh__s.html">mysh_t</a> *mysh)</td></tr>
<tr class="memdesc:a7ede9de6e91a986a8f4b32bcfb9e0016"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end builtin. <br /></td></tr>
<tr class="separator:a7ede9de6e91a986a8f4b32bcfb9e0016"><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>The file containing the end builtin. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a7ede9de6e91a986a8f4b32bcfb9e0016" name="a7ede9de6e91a986a8f4b32bcfb9e0016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ede9de6e91a986a8f4b32bcfb9e0016">&#9670;&#160;</a></span>exec_end()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int exec_end </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmysh__s.html">mysh_t</a> *</td> <td class="paramname"><span class="paramname"><em>mysh</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>The end builtin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mysh</td><td>The shell structure </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>int</b> Always <u>1</u> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1909b13b6d0cbcc1d36d622424b54e1c.html">builtins</a></li><li class="navelem"><a class="el" href="end_8c.html">end.c</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
</ul>
</div>
</body>
</html>
4 changes: 4 additions & 0 deletions docs/html/end_8c.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
var end_8c =
[
[ "exec_end", "end_8c.html#a7ede9de6e91a986a8f4b32bcfb9e0016", null ]
];
34 changes: 34 additions & 0 deletions docs/html/exit_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@
</div><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:a0af467f1a8a33e4e7914c10fbba2ed65" id="r_a0af467f1a8a33e4e7914c10fbba2ed65"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0af467f1a8a33e4e7914c10fbba2ed65">free_str_and_tab</a> (char *str, char **tab)</td></tr>
<tr class="memdesc:a0af467f1a8a33e4e7914c10fbba2ed65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an string and his array. <br /></td></tr>
<tr class="separator:a0af467f1a8a33e4e7914c10fbba2ed65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbf8844693b9a7029c360b0e6155ff3d" id="r_adbf8844693b9a7029c360b0e6155ff3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbf8844693b9a7029c360b0e6155ff3d">free_input_list</a> (<a class="el" href="structmysh__s.html">mysh_t</a> *mysh)</td></tr>
<tr class="memdesc:adbf8844693b9a7029c360b0e6155ff3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the input list. <br /></td></tr>
<tr class="separator:adbf8844693b9a7029c360b0e6155ff3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -172,6 +175,37 @@ <h2 class="memtitle"><span class="permalink"><a href="#adbf8844693b9a7029c360b0e
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>void</b> </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * free_str_and_tab </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>tab</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">

<p>Free an string and his array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string to free </td></tr>
<tr><td class="paramname">tab</td><td>The array of the string to free </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>void *</b> Always <u>NULL</u> </dd></dl>

</div>
</div>
<a id="a38b067099aa9b0d47d58f7049be1de3e" name="a38b067099aa9b0d47d58f7049be1de3e"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/html/exit_8c.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ var exit_8c =
[
[ "exec_exit", "exit_8c.html#a79d59c6bdeb3a8b951bdd9604a758d61", null ],
[ "free_input_list", "exit_8c.html#adbf8844693b9a7029c360b0e6155ff3d", null ],
[ "free_str_and_tab", "exit_8c.html#a0af467f1a8a33e4e7914c10fbba2ed65", null ],
[ "my_exit", "exit_8c.html#a38b067099aa9b0d47d58f7049be1de3e", null ]
];
Loading

0 comments on commit 935db2b

Please sign in to comment.