started woking on figuring out doxygen documentation and added readme
This commit is contained in:
parent
c598f3e106
commit
3f0556341c
1192 changed files with 199462 additions and 29 deletions
203
doc/doxygen/html/de/df7/time_8h.html
Normal file
203
doc/doxygen/html/de/df7/time_8h.html
Normal file
|
|
@ -0,0 +1,203 @@
|
|||
<!-- 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/time.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"> 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&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('de/df7/time_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="#nested-classes">Data Structures</a> |
|
||||
<a href="#typedef-members">Typedefs</a> |
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle"><div class="title">time.h File Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include <stdint.h></code><br />
|
||||
<code>#include <<a class="el" href="../../de/df7/time_8h_source.html">time.h</a>></code><br />
|
||||
</div>
|
||||
<p><a href="../../de/df7/time_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="nested-classes" name="nested-classes"></a>
|
||||
Data Structures</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dba/structARC__Time.html">ARC_Time</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">the <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> data structre based on <a class="el" href="../../de/df7/time_8h.html">time.h</a> (mainly added to avoid having to type <code>struct tm</code> every time) <a href="../../da/dba/structARC__Time.html#details">More...</a><br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><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:a7bbd69c14efedf01108730576c87c3d1" id="r_a7bbd69c14efedf01108730576c87c3d1"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_Time </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7bbd69c14efedf01108730576c87c3d1">ARC_Time</a></td></tr>
|
||||
<tr class="memdesc:a7bbd69c14efedf01108730576c87c3d1"><td class="mdescLeft"> </td><td class="mdescRight">the <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> data structre based on <a class="el" href="../../de/df7/time_8h.html">time.h</a> (mainly added to avoid having to type <code>struct tm</code> every time) <br /></td></tr>
|
||||
<tr class="separator:a7bbd69c14efedf01108730576c87c3d1"><td class="memSeparator" colspan="2"> </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:a77e3c70990681ec05eef64214b61efab" id="r_a77e3c70990681ec05eef64214b61efab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/dba/structARC__Time.html">ARC_Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a77e3c70990681ec05eef64214b61efab">ARC_Time_CopyFromStructTmPtr</a> (struct tm *time)</td></tr>
|
||||
<tr class="memdesc:a77e3c70990681ec05eef64214b61efab"><td class="mdescLeft"> </td><td class="mdescRight">copies the contents of a tm struct pointer into the <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> type <br /></td></tr>
|
||||
<tr class="separator:a77e3c70990681ec05eef64214b61efab"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Typedef Documentation</h2>
|
||||
<a id="a7bbd69c14efedf01108730576c87c3d1" name="a7bbd69c14efedf01108730576c87c3d1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7bbd69c14efedf01108730576c87c3d1">◆ </a></span>ARC_Time</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">typedef struct ARC_Time ARC_Time</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>the <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> data structre based on <a class="el" href="../../de/df7/time_8h.html">time.h</a> (mainly added to avoid having to type <code>struct tm</code> every time) </p>
|
||||
<p>seconds == tm_sec [0,60] minutes == tm_min [0,59] hour == tm_hour [0,23]</p>
|
||||
<p>day == tm_yday Day of year [0,365] month == tm_mon Month of year [0,11] year == tm_year Years since 1900</p>
|
||||
<p>dayOfWeek == tm_wday Day of week [0,6] (Sunday =0) dayOfMonth == tm_mday Day of month [1,31]</p>
|
||||
<p>daylightSavingsFlag == tm_isdst Daylight Savings flag </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a77e3c70990681ec05eef64214b61efab" name="a77e3c70990681ec05eef64214b61efab"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a77e3c70990681ec05eef64214b61efab">◆ </a></span>ARC_Time_CopyFromStructTmPtr()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="../../da/dba/structARC__Time.html">ARC_Time</a> ARC_Time_CopyFromStructTmPtr </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">struct tm *</td> <td class="paramname"><span class="paramname"><em>time</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>copies the contents of a tm struct pointer into the <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> type </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">time</td><td>the struct tm type to copy</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>the contents of a struct tm as an <a class="el" href="../../da/dba/structARC__Time.html" title="the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...">ARC_Time</a> </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="../../de/df7/time_8h.html">time.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>
|
||||
6
doc/doxygen/html/de/df7/time_8h.js
Normal file
6
doc/doxygen/html/de/df7/time_8h.js
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
var time_8h =
|
||||
[
|
||||
[ "ARC_Time", "da/dba/structARC__Time.html", "da/dba/structARC__Time" ],
|
||||
[ "ARC_Time", "de/df7/time_8h.html#a7bbd69c14efedf01108730576c87c3d1", null ],
|
||||
[ "ARC_Time_CopyFromStructTmPtr", "de/df7/time_8h.html#a77e3c70990681ec05eef64214b61efab", null ]
|
||||
];
|
||||
198
doc/doxygen/html/de/df7/time_8h_source.html
Normal file
198
doc/doxygen/html/de/df7/time_8h_source.html
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
<!-- 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/time.h Source File</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"> 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&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('de/df7/time_8h_source.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="headertitle"><div class="title">time.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="../../de/df7/time_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_STD_TIME_H_</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_TIME_H_</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <stdint.h></span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="../../de/df7/time_8h.html">time.h</a>></span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @brief the ARC_Time data structre based on time.h (mainly added to avoid having to type `struct tm` every time)</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * seconds == tm_sec [0,60]</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * minutes == tm_min [0,59]</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * hour == tm_hour [0,23]</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * day == tm_yday Day of year [0,365]</span></div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * month == tm_mon Month of year [0,11]</span></div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * year == tm_year Years since 1900</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * dayOfWeek == tm_wday Day of week [0,6] (Sunday =0)</span></div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * dayOfMonth == tm_mday Day of month [1,31]</span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * daylightSavingsFlag == tm_isdst Daylight Savings flag</span></div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">*/</span></div>
|
||||
<div class="foldopen" id="foldopen00027" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html"> 27</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../da/dba/structARC__Time.html">ARC_Time</a> {</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a68a4a28539022e515a98e4ce2a90c6eb"> 28</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a68a4a28539022e515a98e4ce2a90c6eb">seconds</a>;</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a8c565e90558bc91410c58a92d886b617"> 29</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a8c565e90558bc91410c58a92d886b617">minutes</a>;</div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#ae005a5f84468e1132d30e3236cdc438c"> 30</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#ae005a5f84468e1132d30e3236cdc438c">hour</a>;</div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a2a9169423e341331c85ecc39caadd783"> 32</a></span> uint32_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a2a9169423e341331c85ecc39caadd783">day</a>;</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a0ab8ffc0607c9c29418d14c70cfe641c"> 33</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a0ab8ffc0607c9c29418d14c70cfe641c">month</a>;</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a0868e95272e5c94b6c66d9e4d0de2c7e"> 34</a></span> uint32_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a0868e95272e5c94b6c66d9e4d0de2c7e">year</a>;</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a2f1090e8effc74bedced74b774fdf2cb"> 36</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a2f1090e8effc74bedced74b774fdf2cb">dayOfWeek</a>;</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#a5c43f775fe3bdada2159d1862dc7bc8e"> 37</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#a5c43f775fe3bdada2159d1862dc7bc8e">dayOfMonth</a>;</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="../../da/dba/structARC__Time.html#aeb601e28e2f709014ec618beeb8f06a3"> 39</a></span> uint8_t <a class="code hl_variable" href="../../da/dba/structARC__Time.html#aeb601e28e2f709014ec618beeb8f06a3">daylightSavingsFlag</a>;</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="../../de/df7/time_8h.html#a7bbd69c14efedf01108730576c87c3d1"> 40</a></span>} <a class="code hl_typedef" href="../../de/df7/time_8h.html#a7bbd69c14efedf01108730576c87c3d1">ARC_Time</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @brief copies the contents of a tm struct pointer into the ARC_Time type</span></div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param time the struct tm type to copy</span></div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @return the contents of a struct tm as an ARC_Time</span></div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">*/</span></div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="../../de/df7/time_8h.html#a77e3c70990681ec05eef64214b61efab"> 49</a></span><a class="code hl_struct" href="../../da/dba/structARC__Time.html">ARC_Time</a> <a class="code hl_function" href="../../de/df7/time_8h.html#a77e3c70990681ec05eef64214b61efab">ARC_Time_CopyFromStructTmPtr</a>(<span class="keyword">struct</span> tm *time);</div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>}</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_STD_TIME_H_</span></div>
|
||||
<div class="ttc" id="astructARC__Time_html"><div class="ttname"><a href="../../da/dba/structARC__Time.html">ARC_Time</a></div><div class="ttdoc">the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...</div><div class="ttdef"><b>Definition</b> <a href="#l00027">time.h:27</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a0868e95272e5c94b6c66d9e4d0de2c7e"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a0868e95272e5c94b6c66d9e4d0de2c7e">ARC_Time::year</a></div><div class="ttdeci">uint32_t year</div><div class="ttdef"><b>Definition</b> <a href="#l00034">time.h:34</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a0ab8ffc0607c9c29418d14c70cfe641c"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a0ab8ffc0607c9c29418d14c70cfe641c">ARC_Time::month</a></div><div class="ttdeci">uint8_t month</div><div class="ttdef"><b>Definition</b> <a href="#l00033">time.h:33</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a2a9169423e341331c85ecc39caadd783"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a2a9169423e341331c85ecc39caadd783">ARC_Time::day</a></div><div class="ttdeci">uint32_t day</div><div class="ttdef"><b>Definition</b> <a href="#l00032">time.h:32</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a2f1090e8effc74bedced74b774fdf2cb"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a2f1090e8effc74bedced74b774fdf2cb">ARC_Time::dayOfWeek</a></div><div class="ttdeci">uint8_t dayOfWeek</div><div class="ttdef"><b>Definition</b> <a href="#l00036">time.h:36</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a5c43f775fe3bdada2159d1862dc7bc8e"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a5c43f775fe3bdada2159d1862dc7bc8e">ARC_Time::dayOfMonth</a></div><div class="ttdeci">uint8_t dayOfMonth</div><div class="ttdef"><b>Definition</b> <a href="#l00037">time.h:37</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a68a4a28539022e515a98e4ce2a90c6eb"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a68a4a28539022e515a98e4ce2a90c6eb">ARC_Time::seconds</a></div><div class="ttdeci">uint8_t seconds</div><div class="ttdef"><b>Definition</b> <a href="#l00028">time.h:28</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_a8c565e90558bc91410c58a92d886b617"><div class="ttname"><a href="../../da/dba/structARC__Time.html#a8c565e90558bc91410c58a92d886b617">ARC_Time::minutes</a></div><div class="ttdeci">uint8_t minutes</div><div class="ttdef"><b>Definition</b> <a href="#l00029">time.h:29</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_ae005a5f84468e1132d30e3236cdc438c"><div class="ttname"><a href="../../da/dba/structARC__Time.html#ae005a5f84468e1132d30e3236cdc438c">ARC_Time::hour</a></div><div class="ttdeci">uint8_t hour</div><div class="ttdef"><b>Definition</b> <a href="#l00030">time.h:30</a></div></div>
|
||||
<div class="ttc" id="astructARC__Time_html_aeb601e28e2f709014ec618beeb8f06a3"><div class="ttname"><a href="../../da/dba/structARC__Time.html#aeb601e28e2f709014ec618beeb8f06a3">ARC_Time::daylightSavingsFlag</a></div><div class="ttdeci">uint8_t daylightSavingsFlag</div><div class="ttdef"><b>Definition</b> <a href="#l00039">time.h:39</a></div></div>
|
||||
<div class="ttc" id="atime_8h_html"><div class="ttname"><a href="../../de/df7/time_8h.html">time.h</a></div></div>
|
||||
<div class="ttc" id="atime_8h_html_a77e3c70990681ec05eef64214b61efab"><div class="ttname"><a href="../../de/df7/time_8h.html#a77e3c70990681ec05eef64214b61efab">ARC_Time_CopyFromStructTmPtr</a></div><div class="ttdeci">ARC_Time ARC_Time_CopyFromStructTmPtr(struct tm *time)</div><div class="ttdoc">copies the contents of a tm struct pointer into the ARC_Time type</div></div>
|
||||
<div class="ttc" id="atime_8h_html_a7bbd69c14efedf01108730576c87c3d1"><div class="ttname"><a href="../../de/df7/time_8h.html#a7bbd69c14efedf01108730576c87c3d1">ARC_Time</a></div><div class="ttdeci">struct ARC_Time ARC_Time</div><div class="ttdoc">the ARC_Time data structre based on time.h (mainly added to avoid having to type struct tm every time...</div></div>
|
||||
</div><!-- fragment --></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="../../de/df7/time_8h.html">time.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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue