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('classout__pwm.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,32 +97,21 @@ $(function() {
<div class="dynheader">
Inheritance diagram for out_pwm:</div>
<div class="dyncontent">
<div class="center"><img src="classout__pwm__inherit__graph.png" border="0" usemap="#aout__pwm_inherit__map" alt="Inheritance graph"/></div>
<map name="out__pwm_inherit__map" id="aout__pwm_inherit__map">
<area shape="rect" title=" " alt="" coords="17,229,92,256"/>
<area shape="rect" href="classcolor_channel.html" title=" " alt="" coords="5,155,104,181"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="9,80,100,107"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="11,5,98,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for out_pwm:</div>
<div class="dyncontent">
<div class="center"><img src="classout__pwm__coll__graph.png" border="0" usemap="#aout__pwm_coll__map" alt="Collaboration graph"/></div>
<map name="out__pwm_coll__map" id="aout__pwm_coll__map">
<area shape="rect" title=" " alt="" coords="17,247,92,273"/>
<area shape="rect" href="classcolor_channel.html" 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="classout__pwm.png" usemap="#out_5Fpwm_map" alt=""/>
<map id="out_5Fpwm_map" name="out_5Fpwm_map">
<area href="classcolor_channel.html" alt="colorChannel" shape="rect" coords="0,112,88,136"/>
<area href="classabstract_out.html" alt="abstractOut" shape="rect" coords="0,56,88,80"/>
<area href="classabstract_ch.html" alt="abstractCh" shape="rect" coords="0,0,88,24"/>
</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>
<tr class="memitem:acd3804fb3d24afe569042202bdba2179"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#acd3804fb3d24afe569042202bdba2179">out_pwm</a> (<a class="el" href="class_item.html">Item</a> *_item)</td></tr>
<tr class="separator:acd3804fb3d24afe569042202bdba2179"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ba3173e9df1cb61b74a705c270ef7b6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#a0ba3173e9df1cb61b74a705c270ef7b6">Setup</a> () override</td></tr>
<tr class="memdesc:a0ba3173e9df1cb61b74a705c270ef7b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove?? Now getChanType used instead. <a href="classout__pwm.html#a0ba3173e9df1cb61b74a705c270ef7b6">More...</a><br /></td></tr>
<tr class="separator:a0ba3173e9df1cb61b74a705c270ef7b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c460e7ba29e5b068a2defa395cae2c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#a88c460e7ba29e5b068a2defa395cae2c">Poll</a> (short cause) override</td></tr>
<tr class="separator:a88c460e7ba29e5b068a2defa395cae2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -108,8 +119,6 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a9f3fc73a1fff6ecf991d42564a7b8273"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01edf9d010b717601898bf3fddecbc3f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#a01edf9d010b717601898bf3fddecbc3f">Status</a> () override</td></tr>
<tr class="separator:a01edf9d010b717601898bf3fddecbc3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18f9c90ab80a5bf00049e25c2c4657a5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#a18f9c90ab80a5bf00049e25c2c4657a5">isActive</a> () override</td></tr>
<tr class="separator:a18f9c90ab80a5bf00049e25c2c4657a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54bea9682560aa628f85a532a363d57a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#a54bea9682560aa628f85a532a363d57a">getChanType</a> () override</td></tr>
<tr class="separator:a54bea9682560aa628f85a532a363d57a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcb4bb3d03aa8c4b7e12796136b5cd1e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout__pwm.html#adcb4bb3d03aa8c4b7e12796136b5cd1e">PixelCtrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool show=true) override</td></tr>
@@ -119,13 +128,17 @@ Public Member Functions</h2></td></tr>
<tr class="separator:af5d8c0be99104c65484560a5a1c2cfd2 inherit pub_methods_classcolor_channel"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d7354cc266c98067b7b43cbf8707feb inherit pub_methods_classcolor_channel"><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 inherit pub_methods_classcolor_channel"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d7b6241409b4e00574b389d3436e1f inherit pub_methods_classcolor_channel"><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 inherit pub_methods_classcolor_channel"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09276ae99835316b9a222df20fb45097 inherit pub_methods_classcolor_channel"><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>
<tr class="separator:a09276ae99835316b9a222df20fb45097 inherit pub_methods_classcolor_channel"><td class="memSeparator" colspan="2">&#160;</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: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="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>
@@ -210,33 +223,6 @@ Additional Inherited Members</h2></td></tr>
<p>Reimplemented from <a class="el" href="classabstract_out.html#a3f7033b9cda791ad810c4837ed5909f2">abstractOut</a>.</p>
</div>
</div>
<a id="a18f9c90ab80a5bf00049e25c2c4657a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18f9c90ab80a5bf00049e25c2c4657a5">&#9670;&nbsp;</a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int out_pwm::isActive </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#aec9af01cfc42f385cdf36ce51c8f3387">abstractOut</a>.</p>
</div>
</div>
<a id="adcb4bb3d03aa8c4b7e12796136b5cd1e"></a>
@@ -334,7 +320,9 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">abstractCh</a>.</p>
<p>Remove?? Now getChanType used instead. </p>
<p>Reimplemented from <a class="el" href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">abstractOut</a>.</p>
</div>
</div>
@@ -416,13 +404,17 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="out__pwm_8h_source.html">out_pwm.h</a></li>
<li><a class="el" href="out__pwm_8cpp.html">out_pwm.cpp</a></li>
<li>modules/<a class="el" href="out__pwm_8h_source.html">out_pwm.h</a></li>
<li>modules/<a class="el" href="out__pwm_8cpp.html">out_pwm.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="classout__pwm.html">out_pwm</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>