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

305
doc/doxygen/html/d8/d38/queue_8h.html Normal file
View file

@ -0,0 +1,305 @@
<!-- 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: /home/herbglitch/programs/archeus/arc/include/arc/std/queue.h 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="../../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('d8/d38/queue_8h.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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">queue.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="../../d8/d38/queue_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5c99fef5a72278c9ae5c410070412201" id="r_a5c99fef5a72278c9ae5c410070412201"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a></td></tr>
<tr class="memdesc:a5c99fef5a72278c9ae5c410070412201"><td class="mdescLeft">&#160;</td><td class="mdescRight">a queue type <br /></td></tr>
<tr class="separator:a5c99fef5a72278c9ae5c410070412201"><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:ae8b1146e12bbf3fb85323f3d142df0bf" id="r_ae8b1146e12bbf3fb85323f3d142df0bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8b1146e12bbf3fb85323f3d142df0bf">ARC_Queue_Create</a> (<a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> **queue)</td></tr>
<tr class="memdesc:ae8b1146e12bbf3fb85323f3d142df0bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_Queue type <br /></td></tr>
<tr class="separator:ae8b1146e12bbf3fb85323f3d142df0bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a02c62a5c9ea508b2ad0f4f6512331d" id="r_a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a02c62a5c9ea508b2ad0f4f6512331d">ARC_Queue_Destroy</a> (<a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroyes ARC_Queue type <br /></td></tr>
<tr class="separator:a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a148faa7bfa969213e32a29aaf3799cd3" id="r_a148faa7bfa969213e32a29aaf3799cd3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a148faa7bfa969213e32a29aaf3799cd3">ARC_Queue_Push</a> (<a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *queue, void *data)</td></tr>
<tr class="memdesc:a148faa7bfa969213e32a29aaf3799cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">pushes value to end of queue <br /></td></tr>
<tr class="separator:a148faa7bfa969213e32a29aaf3799cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dfacddca2614a104273d52726fb4bb9" id="r_a6dfacddca2614a104273d52726fb4bb9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6dfacddca2614a104273d52726fb4bb9">ARC_Queue_Pop</a> (<a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a6dfacddca2614a104273d52726fb4bb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">pops the front off of the ARC_Queue <br /></td></tr>
<tr class="separator:a6dfacddca2614a104273d52726fb4bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a874a468cb3a68e9193618c9d2eac11b6" id="r_a874a468cb3a68e9193618c9d2eac11b6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a874a468cb3a68e9193618c9d2eac11b6">ARC_Queue_Size</a> (<a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a874a468cb3a68e9193618c9d2eac11b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets size of queue <br /></td></tr>
<tr class="separator:a874a468cb3a68e9193618c9d2eac11b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a5c99fef5a72278c9ae5c410070412201" name="a5c99fef5a72278c9ae5c410070412201"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c99fef5a72278c9ae5c410070412201">&#9670;&#160;</a></span>ARC_Queue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> <a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>a queue type </p>
<p class="definition">Definition at line <a class="el" href="../../d8/d38/queue_8h_source.html#l00013">13</a> of file <a class="el" href="../../d8/d38/queue_8h_source.html">queue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae8b1146e12bbf3fb85323f3d142df0bf" name="ae8b1146e12bbf3fb85323f3d142df0bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8b1146e12bbf3fb85323f3d142df0bf">&#9670;&#160;</a></span>ARC_Queue_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> **</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_Queue type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>ARC_Queue to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a02c62a5c9ea508b2ad0f4f6512331d" name="a3a02c62a5c9ea508b2ad0f4f6512331d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a02c62a5c9ea508b2ad0f4f6512331d">&#9670;&#160;</a></span>ARC_Queue_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroyes ARC_Queue type </p>
</div>
</div>
<a id="a6dfacddca2614a104273d52726fb4bb9" name="a6dfacddca2614a104273d52726fb4bb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dfacddca2614a104273d52726fb4bb9">&#9670;&#160;</a></span>ARC_Queue_Pop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * ARC_Queue_Pop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>pops the front off of the ARC_Queue </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>ARC_Queue to remove from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the poped data from the queue as a void * </dd></dl>
</div>
</div>
<a id="a148faa7bfa969213e32a29aaf3799cd3" name="a148faa7bfa969213e32a29aaf3799cd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a148faa7bfa969213e32a29aaf3799cd3">&#9670;&#160;</a></span>ARC_Queue_Push()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>pushes value to end of queue </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>ARC_Queue to push to </td></tr>
<tr><td class="paramname">data</td><td>data that is being pushed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a874a468cb3a68e9193618c9d2eac11b6" name="a874a468cb3a68e9193618c9d2eac11b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a874a468cb3a68e9193618c9d2eac11b6">&#9670;&#160;</a></span>ARC_Queue_Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_Queue_Size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a5c99fef5a72278c9ae5c410070412201">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets size of queue </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vector</td><td>ARC_Queue to get size from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the queues size </dd></dl>
</div>
</div>
</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="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../d8/d38/queue_8h.html">queue.h</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>