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('classcolor_channel.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;
@@ -75,27 +97,16 @@ $(function() {
<div class="dynheader">
Inheritance diagram for colorChannel:</div>
<div class="dyncontent">
<div class="center"><img src="classcolor_channel__inherit__graph.png" border="0" usemap="#acolor_channel_inherit__map" alt="Inheritance graph"/></div>
<map name="color_channel_inherit__map" id="acolor_channel_inherit__map">
<area shape="rect" title=" " alt="" coords="89,155,188,181"/>
<area shape="rect" href="classout__dmx.html" title=" " alt="" coords="5,229,77,256"/>
<area shape="rect" href="classout__pwm.html" title=" " alt="" coords="101,229,176,256"/>
<area shape="rect" href="classout___s_p_i_led.html" title=" " alt="" coords="200,229,291,256"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="93,80,184,107"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="95,5,182,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for colorChannel:</div>
<div class="dyncontent">
<div class="center"><img src="classcolor_channel__coll__graph.png" border="0" usemap="#acolor_channel_coll__map" alt="Collaboration graph"/></div>
<map name="color_channel_coll__map" id="acolor_channel_coll__map">
<area shape="rect" title=" " alt="" coords="5,171,104,197"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="53,81,144,108"/>
<area shape="rect" href="class_item.html" title=" " alt="" coords="135,171,183,197"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="55,5,142,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="center">
<img src="classcolor_channel.png" usemap="#colorChannel_map" alt=""/>
<map id="colorChannel_map" name="colorChannel_map">
<area href="classabstract_out.html" alt="abstractOut" shape="rect" coords="98,56,186,80"/>
<area href="classabstract_ch.html" alt="abstractCh" shape="rect" coords="98,0,186,24"/>
<area href="classout__dmx.html" alt="out_dmx" shape="rect" coords="0,168,88,192"/>
<area href="classout__pwm.html" alt="out_pwm" shape="rect" coords="98,168,186,192"/>
<area href="classout___s_p_i_led.html" alt="out_SPILed" shape="rect" coords="196,168,284,192"/>
</map>
</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>
@@ -103,6 +114,8 @@ Public Member Functions</h2></td></tr>
<tr class="separator:af5d8c0be99104c65484560a5a1c2cfd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d7354cc266c98067b7b43cbf8707feb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a9d7354cc266c98067b7b43cbf8707feb">Ctrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool toExecute=true) override</td></tr>
<tr class="separator:a9d7354cc266c98067b7b43cbf8707feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d7b6241409b4e00574b389d3436e1f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a52d7b6241409b4e00574b389d3436e1f">getDefaultStorageType</a> () override</td></tr>
<tr class="separator:a52d7b6241409b4e00574b389d3436e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c835d00ee8af04679f03465617c2873"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a6c835d00ee8af04679f03465617c2873">PixelCtrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool show=true)=0</td></tr>
<tr class="separator:a6c835d00ee8af04679f03465617c2873"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09276ae99835316b9a222df20fb45097"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a09276ae99835316b9a222df20fb45097">getChannelAddr</a> (short n=0)</td></tr>
@@ -110,12 +123,15 @@ Public Member Functions</h2></td></tr>
<tr class="inherit_header pub_methods_classabstract_out"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classabstract_out')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classabstract_out.html">abstractOut</a></td></tr>
<tr class="memitem:adec371468752bd5027c282cf933ba035 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#adec371468752bd5027c282cf933ba035">abstractOut</a> (<a class="el" href="class_item.html">Item</a> *_item)</td></tr>
<tr class="separator:adec371468752bd5027c282cf933ba035 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec9af01cfc42f385cdf36ce51c8f3387 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aec9af01cfc42f385cdf36ce51c8f3387">isActive</a> ()</td></tr>
<tr class="separator:aec9af01cfc42f385cdf36ce51c8f3387 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedf98f968abc36332dcddb7eab00fe13 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aedf98f968abc36332dcddb7eab00fe13">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:aedf98f968abc36332dcddb7eab00fe13 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4d536357ee52043a4d338ce2106350e inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#af4d536357ee52043a4d338ce2106350e">isActive</a> ()</td></tr>
<tr class="separator:af4d536357ee52043a4d338ce2106350e inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade514d6b6152e87a70d66932c74e1656 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classitem_cmd.html">itemCmd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#ade514d6b6152e87a70d66932c74e1656">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:ade514d6b6152e87a70d66932c74e1656 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7033b9cda791ad810c4837ed5909f2 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#a3f7033b9cda791ad810c4837ed5909f2">getChanType</a> ()</td></tr>
<tr class="separator:a3f7033b9cda791ad810c4837ed5909f2 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad84ffc96dafea9cbe5c91f35c90ffe3b inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">Setup</a> () override</td></tr>
<tr class="memdesc:ad84ffc96dafea9cbe5c91f35c90ffe3b inherit pub_methods_classabstract_out"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove?? Now getChanType used instead. <a href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">More...</a><br /></td></tr>
<tr class="separator:ad84ffc96dafea9cbe5c91f35c90ffe3b inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classabstract_ch"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classabstract_ch')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classabstract_ch.html">abstractCh</a></td></tr>
<tr class="memitem:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed">abstractCh</a> ()</td></tr>
<tr class="separator:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -123,8 +139,6 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a58f34f5341674622c30f5c005ceadead inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a044156a4dc4ca38d3e731b7df23d058a inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">Poll</a> (short cause)=0</td></tr>
<tr class="separator:a044156a4dc4ca38d3e731b7df23d058a inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf6346625245be1774a6d27d9cece4e inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">Setup</a> ()=0</td></tr>
<tr class="separator:aeaf6346625245be1774a6d27d9cece4e inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e75f5b76a25accdb1de0c936951a93f inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a2e75f5b76a25accdb1de0c936951a93f">Anounce</a> ()</td></tr>
<tr class="separator:a2e75f5b76a25accdb1de0c936951a93f inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7b6f4586412a13f8f6ac08061e5ae0 inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0">Stop</a> ()</td></tr>
@@ -240,6 +254,33 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a52d7b6241409b4e00574b389d3436e1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52d7b6241409b4e00574b389d3436e1f">&#9670;&nbsp;</a></span>getDefaultStorageType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int colorChannel::getDefaultStorageType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classabstract_out.html#a786157307bd9438b8fbff24421b95330">abstractOut</a>.</p>
</div>
</div>
<a id="a6c835d00ee8af04679f03465617c2873"></a>
@@ -336,9 +377,13 @@ Additional Inherited Members</h2></td></tr>
<li><a class="el" href="colorchannel_8cpp.html">colorchannel.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="classcolor_channel.html">colorChannel</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>