herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

started woking on figuring out doxygen documentation and added readme

Browse source
This commit is contained in:
herbglitch 2024-12-24 03:47:16 -07:00
parent c598f3e106
commit 3f0556341c
1192 changed files with 199462 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

287
doc/doxygen/html/d9/d4c/structARC__ConsoleShell.html Normal file
View file

@ -0,0 +1,287 @@
<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: ARC_ConsoleShell Struct 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="../../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" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.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(1); });
/* @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('d9/d4c/structARC__ConsoleShell.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">ARC_ConsoleShell Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a53d8365cb1119f21f0b23fa1abae8c05" id="r_a53d8365cb1119f21f0b23fa1abae8c05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53d8365cb1119f21f0b23fa1abae8c05">view</a></td></tr>
<tr class="separator:a53d8365cb1119f21f0b23fa1abae8c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77c4a161dfbf8ad6c6afc18362c3ec66" id="r_a77c4a161dfbf8ad6c6afc18362c3ec66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a77c4a161dfbf8ad6c6afc18362c3ec66">buffer</a></td></tr>
<tr class="separator:a77c4a161dfbf8ad6c6afc18362c3ec66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25d7454e64c1af58a66288d8a12b04ce" id="r_a25d7454e64c1af58a66288d8a12b04ce"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25d7454e64c1af58a66288d8a12b04ce">bufferLineIndex</a></td></tr>
<tr class="separator:a25d7454e64c1af58a66288d8a12b04ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88f6d6daf79f0464766ae1a912eac0fa" id="r_a88f6d6daf79f0464766ae1a912eac0fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88f6d6daf79f0464766ae1a912eac0fa">history</a></td></tr>
<tr class="separator:a88f6d6daf79f0464766ae1a912eac0fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad860e9556c262f6d02240589c5099b8f" id="r_ad860e9556c262f6d02240589c5099b8f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad860e9556c262f6d02240589c5099b8f">historyIndex</a></td></tr>
<tr class="separator:ad860e9556c262f6d02240589c5099b8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a950522b4dfb71a19621da6b1077ccbdb" id="r_a950522b4dfb71a19621da6b1077ccbdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a950522b4dfb71a19621da6b1077ccbdb">updateFn</a></td></tr>
<tr class="separator:a950522b4dfb71a19621da6b1077ccbdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8671d3299f3352e0a7639464d9eb2d1" id="r_aa8671d3299f3352e0a7639464d9eb2d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8671d3299f3352e0a7639464d9eb2d1">currentLine</a></td></tr>
<tr class="separator:aa8671d3299f3352e0a7639464d9eb2d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9dde7ef4fedcb03abf056d9e189311a" id="r_ac9dde7ef4fedcb03abf056d9e189311a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9dde7ef4fedcb03abf056d9e189311a">userInput</a></td></tr>
<tr class="separator:ac9dde7ef4fedcb03abf056d9e189311a"><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="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00029">29</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a77c4a161dfbf8ad6c6afc18362c3ec66" name="a77c4a161dfbf8ad6c6afc18362c3ec66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77c4a161dfbf8ad6c6afc18362c3ec66">&#9670;&#160;</a></span>buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a>* ARC_ConsoleShell::buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00031">31</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="a25d7454e64c1af58a66288d8a12b04ce" name="a25d7454e64c1af58a66288d8a12b04ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25d7454e64c1af58a66288d8a12b04ce">&#9670;&#160;</a></span>bufferLineIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_ConsoleShell::bufferLineIndex</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00032">32</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="aa8671d3299f3352e0a7639464d9eb2d1" name="aa8671d3299f3352e0a7639464d9eb2d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8671d3299f3352e0a7639464d9eb2d1">&#9670;&#160;</a></span>currentLine</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a>* ARC_ConsoleShell::currentLine</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00039">39</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="a88f6d6daf79f0464766ae1a912eac0fa" name="a88f6d6daf79f0464766ae1a912eac0fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88f6d6daf79f0464766ae1a912eac0fa">&#9670;&#160;</a></span>history</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a>* ARC_ConsoleShell::history</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00034">34</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="ad860e9556c262f6d02240589c5099b8f" name="ad860e9556c262f6d02240589c5099b8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad860e9556c262f6d02240589c5099b8f">&#9670;&#160;</a></span>historyIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_ConsoleShell::historyIndex</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00035">35</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="a950522b4dfb71a19621da6b1077ccbdb" name="a950522b4dfb71a19621da6b1077ccbdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a950522b4dfb71a19621da6b1077ccbdb">&#9670;&#160;</a></span>updateFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a> ARC_ConsoleShell::updateFn</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00037">37</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="ac9dde7ef4fedcb03abf056d9e189311a" name="ac9dde7ef4fedcb03abf056d9e189311a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9dde7ef4fedcb03abf056d9e189311a">&#9670;&#160;</a></span>userInput</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a>* ARC_ConsoleShell::userInput</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00040">40</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<a id="a53d8365cb1119f21f0b23fa1abae8c05" name="a53d8365cb1119f21f0b23fa1abae8c05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d8365cb1119f21f0b23fa1abae8c05">&#9670;&#160;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a>* ARC_ConsoleShell::view</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../df/d03/shell_8h_source.html#l00030">30</a> of file <a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/herbglitch/programs/archeus/arc/include/arc/console/<a class="el" href="../../df/d03/shell_8h_source.html">shell.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>

11
doc/doxygen/html/d9/d4c/structARC__ConsoleShell.js Normal file
View file

@ -0,0 +1,11 @@
var structARC__ConsoleShell =
[
[ "buffer", "d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66", null ],
[ "bufferLineIndex", "d9/d4c/structARC__ConsoleShell.html#a25d7454e64c1af58a66288d8a12b04ce", null ],
[ "currentLine", "d9/d4c/structARC__ConsoleShell.html#aa8671d3299f3352e0a7639464d9eb2d1", null ],
[ "history", "d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa", null ],
[ "historyIndex", "d9/d4c/structARC__ConsoleShell.html#ad860e9556c262f6d02240589c5099b8f", null ],
[ "updateFn", "d9/d4c/structARC__ConsoleShell.html#a950522b4dfb71a19621da6b1077ccbdb", null ],
[ "userInput", "d9/d4c/structARC__ConsoleShell.html#ac9dde7ef4fedcb03abf056d9e189311a", null ],
[ "view", "d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05", null ]
];