doxigen docs

This commit is contained in:
2022-01-06 02:01:16 +03:00
parent 6fe28695f2
commit 07046680e0
628 changed files with 37077 additions and 10502 deletions

View File

@@ -9,6 +9,10 @@
<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>
@@ -23,7 +27,9 @@
<td id="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
&#160;<span id="projectnumber">v4.0.0</span>
</div>
<div id="projectbrief">Smarthome controller firmware</div>
</td>
</tr>
</tbody>
@@ -46,6 +52,23 @@ $(function() {
});
/* @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_streamlog.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -60,7 +83,6 @@ $(function() {
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
@@ -74,26 +96,14 @@ $(function() {
<div class="dynheader">
Inheritance diagram for Streamlog:</div>
<div class="dyncontent">
<div class="center"><img src="class_streamlog__inherit__graph.png" border="0" usemap="#a_streamlog_inherit__map" alt="Inheritance graph"/></div>
<map name="_streamlog_inherit__map" id="a_streamlog_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,87,107"/>
<area shape="rect" title=" " alt="" coords="21,5,71,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Streamlog:</div>
<div class="dyncontent">
<div class="center"><img src="class_streamlog__coll__graph.png" border="0" usemap="#a_streamlog_coll__map" alt="Collaboration graph"/></div>
<map name="_streamlog_coll__map" id="a_streamlog_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,87,107"/>
<area shape="rect" title=" " alt="" coords="21,5,71,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="center">
<img src="class_streamlog.png" alt=""/>
</div></div>
<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:a51cd1bbe03b32ad2d4235b4ef7945d37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#a51cd1bbe03b32ad2d4235b4ef7945d37">Streamlog</a> (HardwareSerial *_serialPort, int _severity=<a class="el" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a>, uint8_t _ledPattern=0)</td></tr>
<tr class="separator:a51cd1bbe03b32ad2d4235b4ef7945d37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3d6de674a30268eeb1c3fcc45e9bd47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#aa3d6de674a30268eeb1c3fcc45e9bd47">Streamlog</a> (<a class="el" href="streamlog_8h.html#ace67e7b92ea9c2ca0cf0cc6c201ccbc2">SerialPortType</a> *_serialPort, uint8_t _severity=<a class="el" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a>, uint8_t _ledPattern=0)</td></tr>
<tr class="separator:aa3d6de674a30268eeb1c3fcc45e9bd47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c1022fccf6b585b738f30f8577d613"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#ab9c1022fccf6b585b738f30f8577d613">begin</a> (unsigned long speed)</td></tr>
<tr class="separator:ab9c1022fccf6b585b738f30f8577d613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6e3e265ae590b7f3b14b926bc3e60b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#ace6e3e265ae590b7f3b14b926bc3e60b">end</a> ()</td></tr>
@@ -112,8 +122,8 @@ Public Member Functions</h2></td></tr>
<tr class="separator:adcd1dcab71fd1e1c9da5bc9c18ac3d1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a51cd1bbe03b32ad2d4235b4ef7945d37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51cd1bbe03b32ad2d4235b4ef7945d37">&#9670;&nbsp;</a></span>Streamlog()</h2>
<a id="aa3d6de674a30268eeb1c3fcc45e9bd47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3d6de674a30268eeb1c3fcc45e9bd47">&#9670;&nbsp;</a></span>Streamlog()</h2>
<div class="memitem">
<div class="memproto">
@@ -121,13 +131,13 @@ Public Member Functions</h2></td></tr>
<tr>
<td class="memname">Streamlog::Streamlog </td>
<td>(</td>
<td class="paramtype">HardwareSerial *&#160;</td>
<td class="paramtype"><a class="el" href="streamlog_8h.html#ace67e7b92ea9c2ca0cf0cc6c201ccbc2">SerialPortType</a> *&#160;</td>
<td class="paramname"><em>_serialPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>_severity</em> = <code><a class="el" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a></code>, </td>
</tr>
<tr>
@@ -302,9 +312,13 @@ Public Member Functions</h2></td></tr>
<li><a class="el" href="streamlog_8cpp.html">streamlog.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_streamlog.html">Streamlog</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>