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

174
doc/doxygen/html/d4/db5/tests_2std_2chemical_8c.html Normal file
View file

@ -0,0 +1,174 @@
<!-- 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/tests/std/chemical.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="../../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('d4/db5/tests_2std_2chemical_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">chemical.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d2/ddc/test_8h_source.html">../test.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/dc2/errno_8h_source.html">arc/std/errno.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../de/de8/chemical_8h_source.html">arc/std/chemical.h</a>&quot;</code><br />
</div>
<p><a href="../../d4/db5/tests_2std_2chemical_8c_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b61dff4da7687b01700ba2a9838f590" id="r_a4b61dff4da7687b01700ba2a9838f590"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b61dff4da7687b01700ba2a9838f590">ARC_TEST</a> (Chemical_BasicTest)</td></tr>
<tr class="separator:a4b61dff4da7687b01700ba2a9838f590"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4b61dff4da7687b01700ba2a9838f590" name="a4b61dff4da7687b01700ba2a9838f590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b61dff4da7687b01700ba2a9838f590">&#9670;&#160;</a></span>ARC_TEST()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARC_TEST </td>
<td>(</td>
<td class="paramtype">Chemical_BasicTest</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d4/db5/tests_2std_2chemical_8c_source.html#l00007">7</a> of file <a class="el" href="../../d4/db5/tests_2std_2chemical_8c_source.html">chemical.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 7</span> {</div>
<div class="line"><span class="lineno"> 8</span> <a class="code hl_struct" href="../../de/d74/structARC__Chemical.html">ARC_Chemical</a> *chemical;</div>
<div class="line"><span class="lineno"> 9</span> <a class="code hl_function" href="../../da/d10/src_2std_2chemical_8c.html#a57285cb04aa534e1d031332dcaa1a870">ARC_Chemical_Create</a>(&amp;chemical);</div>
<div class="line"><span class="lineno"> 10</span> </div>
<div class="line"><span class="lineno"> 11</span> </div>
<div class="line"><span class="lineno"> 12</span> <span class="comment">//cleanup</span></div>
<div class="line"><span class="lineno"> 13</span> <a class="code hl_function" href="../../da/d10/src_2std_2chemical_8c.html#a686a72bf4514fe44106185d4b5c588ef">ARC_Chemical_Destroy</a>(chemical);</div>
<div class="line"><span class="lineno"> 14</span>}</div>
<div class="ttc" id="asrc_2std_2chemical_8c_html_a57285cb04aa534e1d031332dcaa1a870"><div class="ttname"><a href="../../da/d10/src_2std_2chemical_8c.html#a57285cb04aa534e1d031332dcaa1a870">ARC_Chemical_Create</a></div><div class="ttdeci">void ARC_Chemical_Create(ARC_Chemical **chemical)</div><div class="ttdoc">TODO: write this.</div><div class="ttdef"><b>Definition</b> <a href="../../da/d10/src_2std_2chemical_8c_source.html#l00036">chemical.c:36</a></div></div>
<div class="ttc" id="asrc_2std_2chemical_8c_html_a686a72bf4514fe44106185d4b5c588ef"><div class="ttname"><a href="../../da/d10/src_2std_2chemical_8c.html#a686a72bf4514fe44106185d4b5c588ef">ARC_Chemical_Destroy</a></div><div class="ttdeci">void ARC_Chemical_Destroy(ARC_Chemical *chemical)</div><div class="ttdoc">TODO: write this.</div><div class="ttdef"><b>Definition</b> <a href="../../da/d10/src_2std_2chemical_8c_source.html#l00076">chemical.c:76</a></div></div>
<div class="ttc" id="astructARC__Chemical_html"><div class="ttname"><a href="../../de/d74/structARC__Chemical.html">ARC_Chemical</a></div><div class="ttdef"><b>Definition</b> <a href="../../da/d10/src_2std_2chemical_8c_source.html#l00010">chemical.c:10</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../da/d10/src_2std_2chemical_8c_source.html#l00036">ARC_Chemical_Create()</a>, and <a class="el" href="../../da/d10/src_2std_2chemical_8c_source.html#l00076">ARC_Chemical_Destroy()</a>.</p>
</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_59425e443f801f1f2fd8bbe4959a3ccf.html">tests</a></li><li class="navelem"><a class="el" href="../../dir_74e8f229f95a2dcbfc8cf6373759ba2f.html">std</a></li><li class="navelem"><a class="el" href="../../d4/db5/tests_2std_2chemical_8c.html">chemical.c</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>