lauchmelder/SDLU
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation

Browse source
This commit is contained in:
Robert 2021-04-24 02:01:36 +02:00
parent a3726d0887
commit ab2961cf92
413 changed files with 34002 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

184
docs/html/class_clock.html Normal file
View file

@ -0,0 +1,184 @@
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SDL Utility: Clock Class 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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SDL Utility
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_clock.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_clock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Clock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Essentially a timer.
<a href="class_clock.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_clock_8hpp_source.html">Clock.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adbc370eb6b5f8d01645cf440188160a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_clock.html#adbc370eb6b5f8d01645cf440188160a8">Clock</a> ()</td></tr>
<tr class="memdesc:adbc370eb6b5f8d01645cf440188160a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_clock.html" title="Essentially a timer.">Clock</a>. It has not yet been started, call <a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab" title="Restarts the Clock.">Restart()</a> before doing anything else. <a href="class_clock.html#adbc370eb6b5f8d01645cf440188160a8">More...</a><br /></td></tr>
<tr class="separator:adbc370eb6b5f8d01645cf440188160a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4e54aeb04cbe28644343eee710bbdaf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_time.html">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_clock.html#ad4e54aeb04cbe28644343eee710bbdaf">GetElapsedTime</a> ()</td></tr>
<tr class="memdesc:ad4e54aeb04cbe28644343eee710bbdaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the time elapsed since the last <a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab" title="Restarts the Clock.">Restart()</a> call. <a href="class_clock.html#ad4e54aeb04cbe28644343eee710bbdaf">More...</a><br /></td></tr>
<tr class="separator:ad4e54aeb04cbe28644343eee710bbdaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5909f7677c453f589ef109c5e30251ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_time.html">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab">Restart</a> ()</td></tr>
<tr class="memdesc:a5909f7677c453f589ef109c5e30251ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restarts the <a class="el" href="class_clock.html" title="Essentially a timer.">Clock</a>. <a href="class_clock.html#a5909f7677c453f589ef109c5e30251ab">More...</a><br /></td></tr>
<tr class="separator:a5909f7677c453f589ef109c5e30251ab"><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>Essentially a timer. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adbc370eb6b5f8d01645cf440188160a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbc370eb6b5f8d01645cf440188160a8">&#9670;&nbsp;</a></span>Clock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Clock::Clock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="class_clock.html" title="Essentially a timer.">Clock</a>. It has not yet been started, call <a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab" title="Restarts the Clock.">Restart()</a> before doing anything else. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad4e54aeb04cbe28644343eee710bbdaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4e54aeb04cbe28644343eee710bbdaf">&#9670;&nbsp;</a></span>GetElapsedTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_time.html">Time</a> Clock::GetElapsedTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the time elapsed since the last <a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab" title="Restarts the Clock.">Restart()</a> call. </p>
</div>
</div>
<a id="a5909f7677c453f589ef109c5e30251ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5909f7677c453f589ef109c5e30251ab">&#9670;&nbsp;</a></span>Restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_time.html">Time</a> Clock::Restart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restarts the <a class="el" href="class_clock.html" title="Essentially a timer.">Clock</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>The time elapsed since the last <a class="el" href="class_clock.html#a5909f7677c453f589ef109c5e30251ab" title="Restarts the Clock.">Restart()</a> call. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/Robert/source/repos/SDLU/include/structures/<a class="el" href="_clock_8hpp_source.html">Clock.hpp</a></li>
</ul>
</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="class_clock.html">Clock</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.9.1 </li>
</ul>
</div>
</body>
</html>