Skip to content

Commit 90c4741

Browse files
committed
docs update for release 1.0.1
1 parent 76166fa commit 90c4741

File tree

92 files changed

+2303
-2040
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+2303
-2040
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = "LEDDriver_NXP_Arduino"
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 1.0.0
51+
PROJECT_NUMBER = 1.0.1
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

docs/_gradation_control_8cpp_source.html

Lines changed: 38 additions & 13 deletions
Large diffs are not rendered by default.

docs/_gradation_control_8h_source.html

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.7"/>
6+
<meta name="generator" content="Doxygen 1.10.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>LEDDriver_NXP_Arduino: GradationControl.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<script type="text/javascript" src="cookie.js"></script>
1214
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1315
<script type="text/javascript" src="search/searchdata.js"></script>
1416
<script type="text/javascript" src="search/search.js"></script>
@@ -21,7 +23,7 @@
2123
<tbody>
2224
<tr id="projectrow">
2325
<td id="projectalign">
24-
<div id="projectname">LEDDriver_NXP_Arduino<span id="projectnumber">&#160;1.0.0</span>
26+
<div id="projectname">LEDDriver_NXP_Arduino<span id="projectnumber">&#160;1.0.1</span>
2527
</div>
2628
<div id="projectbrief">LED driver device operation sample code for Arduino</div>
2729
</td>
@@ -30,7 +32,7 @@
3032
</table>
3133
</div>
3234
<!-- end header part -->
33-
<!-- Generated by Doxygen 1.9.7 -->
35+
<!-- Generated by Doxygen 1.10.0 -->
3436
<script type="text/javascript">
3537
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3638
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -42,11 +44,16 @@
4244
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4345
$(function() {
4446
initMenu('',true,false,'search.php','Search');
45-
$(document).ready(function() { init_search(); });
47+
$(function() { init_search(); });
4648
});
4749
/* @license-end */
4850
</script>
4951
<div id="main-nav"></div>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
54+
$(function() { codefold.init(0); });
55+
/* @license-end */
56+
</script>
5057
<!-- window showing the filter options -->
5158
<div id="MSearchSelectWindow"
5259
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -83,21 +90,24 @@
8390
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
8491
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;LEDDriver.h&gt;</span></div>
8592
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
93+
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
8694
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_gradation_control.html"> 20</a></span><span class="keyword">class </span><a class="code hl_class" href="class_gradation_control.html">GradationControl</a></div>
8795
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
8896
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">public</span>:</div>
8997
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
98+
<div class="foldopen" id="foldopen00025" data-start="{" data-end="};">
9099
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_gradation_control.html#aaa9f0a75203764f128858991301bf099"> 25</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="class_gradation_control.html#aaa9f0a75203764f128858991301bf099">control</a> : <span class="keywordtype">int</span></div>
91100
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> {</div>
92101
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> STOP,</div>
93102
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> DUMMY,</div>
94103
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ONE_SHOT,</div>
95104
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> CONTINUOUS,</div>
96105
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> };</div>
106+
</div>
97107
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
98108
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_gradation_control.html#a8cbbebc831b5b3d93fa281dfa87fcd78"> 34</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_gradation_control.html#a8cbbebc831b5b3d93fa281dfa87fcd78">cycle</a>;</div>
99109
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
100-
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="class_gradation_control.html">GradationControl</a>( <a class="code hl_class" href="class_p_c_a995x.html">PCA995x</a>* devp, <span class="keywordtype">int</span> num_group, uint32_t bitmap = 0x0000 );</div>
110+
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_function" href="class_gradation_control.html#a3852269547504376e809fcd76edac965">GradationControl</a>( <a class="code hl_class" href="class_p_c_a995x.html">PCA995x</a>* devp, <span class="keywordtype">int</span> num_group, uint32_t bitmap = 0x0000 );</div>
101111
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
102112
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">virtual</span> <a class="code hl_function" href="class_gradation_control.html#a8424feac87d38c7811f5704b9cd835b3">~GradationControl</a>();</div>
103113
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
@@ -120,23 +130,25 @@
120130
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">const</span> <span class="keywordtype">int</span> group;</div>
121131
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">float</span> HOLDTIME[];</div>
122132
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>};</div>
133+
</div>
123134
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
124135
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="preprocessor">#endif </span><span class="comment">// ARDUINO_GRADATION_CONTROL_NXP_ARD_H</span></div>
125-
<div class="ttc" id="aclass_gradation_control_html"><div class="ttname"><a href="class_gradation_control.html">GradationControl</a></div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8h_source.html#l00020">GradationControl.h:21</a></div></div>
136+
<div class="ttc" id="aclass_gradation_control_html"><div class="ttname"><a href="class_gradation_control.html">GradationControl</a></div><div class="ttdef"><b>Definition</b> <a href="#l00020">GradationControl.h:21</a></div></div>
126137
<div class="ttc" id="aclass_gradation_control_html_a169450a9144949e9538011d1ca4bb835"><div class="ttname"><a href="class_gradation_control.html#a169450a9144949e9538011d1ca4bb835">GradationControl::start</a></div><div class="ttdeci">void start(bool continuous=true)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00170">GradationControl.cpp:170</a></div></div>
127138
<div class="ttc" id="aclass_gradation_control_html_a2008e0dc1462804f29602e9f7d1dd361"><div class="ttname"><a href="class_gradation_control.html#a2008e0dc1462804f29602e9f7d1dd361">GradationControl::stop</a></div><div class="ttdeci">void stop(void)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00175">GradationControl.cpp:175</a></div></div>
128139
<div class="ttc" id="aclass_gradation_control_html_a3625cb2bbd9c82b331f4deaef948b7e6"><div class="ttname"><a href="class_gradation_control.html#a3625cb2bbd9c82b331f4deaef948b7e6">GradationControl::gradation_channel_enable</a></div><div class="ttdeci">void gradation_channel_enable(uint32_t bitmap)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00087">GradationControl.cpp:87</a></div></div>
140+
<div class="ttc" id="aclass_gradation_control_html_a3852269547504376e809fcd76edac965"><div class="ttname"><a href="class_gradation_control.html#a3852269547504376e809fcd76edac965">GradationControl::GradationControl</a></div><div class="ttdeci">GradationControl(PCA995x *devp, int num_group, uint32_t bitmap=0x0000)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00003">GradationControl.cpp:3</a></div></div>
129141
<div class="ttc" id="aclass_gradation_control_html_a7a15e266570a694e416d953aa8bd7cd5"><div class="ttname"><a href="class_gradation_control.html#a7a15e266570a694e416d953aa8bd7cd5">GradationControl::gradation_group_assign</a></div><div class="ttdeci">void gradation_group_assign(uint32_t bitmap)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00101">GradationControl.cpp:101</a></div></div>
130142
<div class="ttc" id="aclass_gradation_control_html_a8424feac87d38c7811f5704b9cd835b3"><div class="ttname"><a href="class_gradation_control.html#a8424feac87d38c7811f5704b9cd835b3">GradationControl::~GradationControl</a></div><div class="ttdeci">virtual ~GradationControl()</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00010">GradationControl.cpp:10</a></div></div>
131-
<div class="ttc" id="aclass_gradation_control_html_a8cbbebc831b5b3d93fa281dfa87fcd78"><div class="ttname"><a href="class_gradation_control.html#a8cbbebc831b5b3d93fa281dfa87fcd78">GradationControl::cycle</a></div><div class="ttdeci">float cycle</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8h_source.html#l00034">GradationControl.h:34</a></div></div>
143+
<div class="ttc" id="aclass_gradation_control_html_a8cbbebc831b5b3d93fa281dfa87fcd78"><div class="ttname"><a href="class_gradation_control.html#a8cbbebc831b5b3d93fa281dfa87fcd78">GradationControl::cycle</a></div><div class="ttdeci">float cycle</div><div class="ttdef"><b>Definition</b> <a href="#l00034">GradationControl.h:34</a></div></div>
132144
<div class="ttc" id="aclass_gradation_control_html_aa40d8730e0cd996c0744a47231cddbf1"><div class="ttname"><a href="class_gradation_control.html#aa40d8730e0cd996c0744a47231cddbf1">GradationControl::add_channel</a></div><div class="ttdeci">void add_channel(uint8_t ch)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00125">GradationControl.cpp:125</a></div></div>
133-
<div class="ttc" id="aclass_gradation_control_html_aaa9f0a75203764f128858991301bf099"><div class="ttname"><a href="class_gradation_control.html#aaa9f0a75203764f128858991301bf099">GradationControl::control</a></div><div class="ttdeci">control</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8h_source.html#l00025">GradationControl.h:26</a></div></div>
145+
<div class="ttc" id="aclass_gradation_control_html_aaa9f0a75203764f128858991301bf099"><div class="ttname"><a href="class_gradation_control.html#aaa9f0a75203764f128858991301bf099">GradationControl::control</a></div><div class="ttdeci">control</div><div class="ttdef"><b>Definition</b> <a href="#l00025">GradationControl.h:26</a></div></div>
134146
<div class="ttc" id="aclass_gradation_control_html_affa2227a7fc375d62c7a1a8d89fd0b1d"><div class="ttname"><a href="class_gradation_control.html#affa2227a7fc375d62c7a1a8d89fd0b1d">GradationControl::set_gradation</a></div><div class="ttdeci">float set_gradation(float max_iref, float time, bool up=true, bool down=true, float on=0.0, float off=0.0, bool hold_on=true, bool hold_off=true)</div><div class="ttdef"><b>Definition</b> <a href="_gradation_control_8cpp_source.html#l00014">GradationControl.cpp:14</a></div></div>
135147
<div class="ttc" id="aclass_p_c_a995x_html"><div class="ttname"><a href="class_p_c_a995x.html">PCA995x</a></div><div class="ttdef"><b>Definition</b> <a href="_l_e_d_driver_8h_source.html#l00094">LEDDriver.h:95</a></div></div>
136148
</div><!-- fragment --></div><!-- contents -->
137149
<!-- start footer part -->
138150
<hr class="footer"/><address class="footer"><small>
139-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
151+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
140152
</small></address>
141153
</body>
142154
</html>

docs/_l_e_d_8cpp_source.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.7"/>
6+
<meta name="generator" content="Doxygen 1.10.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>LEDDriver_NXP_Arduino: LED.cpp Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<script type="text/javascript" src="cookie.js"></script>
1214
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1315
<script type="text/javascript" src="search/searchdata.js"></script>
1416
<script type="text/javascript" src="search/search.js"></script>
@@ -21,7 +23,7 @@
2123
<tbody>
2224
<tr id="projectrow">
2325
<td id="projectalign">
24-
<div id="projectname">LEDDriver_NXP_Arduino<span id="projectnumber">&#160;1.0.0</span>
26+
<div id="projectname">LEDDriver_NXP_Arduino<span id="projectnumber">&#160;1.0.1</span>
2527
</div>
2628
<div id="projectbrief">LED driver device operation sample code for Arduino</div>
2729
</td>
@@ -30,7 +32,7 @@
3032
</table>
3133
</div>
3234
<!-- end header part -->
33-
<!-- Generated by Doxygen 1.9.7 -->
35+
<!-- Generated by Doxygen 1.10.0 -->
3436
<script type="text/javascript">
3537
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3638
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -42,11 +44,16 @@
4244
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4345
$(function() {
4446
initMenu('',true,false,'search.php','Search');
45-
$(document).ready(function() { init_search(); });
47+
$(function() { init_search(); });
4648
});
4749
/* @license-end */
4850
</script>
4951
<div id="main-nav"></div>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
54+
$(function() { codefold.init(0); });
55+
/* @license-end */
56+
</script>
5057
<!-- window showing the filter options -->
5158
<div id="MSearchSelectWindow"
5259
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -95,7 +102,7 @@
95102
</div><!-- fragment --></div><!-- contents -->
96103
<!-- start footer part -->
97104
<hr class="footer"/><address class="footer"><small>
98-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
105+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
99106
</small></address>
100107
</body>
101108
</html>

0 commit comments

Comments
 (0)