doxygen - main.c
This commit is contained in:
		
							
								
								
									
										170
									
								
								html/tmr2_8h_source.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										170
									
								
								html/tmr2_8h_source.html
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,170 @@ | ||||
| <!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" lang="en-US"> | ||||
| <head> | ||||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||||
| <meta name="generator" content="Doxygen 1.9.6"/> | ||||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||||
| <title>Solar panel: mcc_generated_files/tmr2.h Source File</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 id="projectrow"> | ||||
|   <td id="projectalign"> | ||||
|    <div id="projectname">Solar panel | ||||
|    </div> | ||||
|   </td> | ||||
|  </tr> | ||||
|  </tbody> | ||||
| </table> | ||||
| </div> | ||||
| <!-- end header part --> | ||||
| <!-- Generated by Doxygen 1.9.6 --> | ||||
| <script type="text/javascript"> | ||||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||||
| var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||||
| $(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||||
| $(document).ready(function(){initNavTree('tmr2_8h_source.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"> | ||||
| <div id="MSearchResults"> | ||||
| <div class="SRPage"> | ||||
| <div id="SRIndex"> | ||||
| <div id="SRResults"></div> | ||||
| <div class="SRStatus" id="Loading">Loading...</div> | ||||
| <div class="SRStatus" id="Searching">Searching...</div> | ||||
| <div class="SRStatus" id="NoMatches">No Matches</div> | ||||
| </div> | ||||
| </div> | ||||
| </div> | ||||
| </div> | ||||
|  | ||||
| <div class="header"> | ||||
|   <div class="headertitle"><div class="title">tmr2.h</div></div> | ||||
| </div><!--header--> | ||||
| <div class="contents"> | ||||
| <a href="tmr2_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span> </div> | ||||
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment">/*</span></div> | ||||
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">    (c) 2018 Microchip Technology Inc. and its subsidiaries. </span></div> | ||||
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">    </span></div> | ||||
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">    Subject to your compliance with these terms, you may use Microchip software and any </span></div> | ||||
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">    derivatives exclusively with Microchip products. It is your responsibility to comply with third party </span></div> | ||||
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">    license terms applicable to your use of third party software (including open source software) that </span></div> | ||||
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">    may accompany Microchip software.</span></div> | ||||
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">    </span></div> | ||||
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">    THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER </span></div> | ||||
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">    EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY </span></div> | ||||
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">    IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS </span></div> | ||||
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">    FOR A PARTICULAR PURPOSE.</span></div> | ||||
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">    </span></div> | ||||
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">    IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, </span></div> | ||||
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND </span></div> | ||||
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">    WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP </span></div> | ||||
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">    HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO </span></div> | ||||
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment">    THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL </span></div> | ||||
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">    CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT </span></div> | ||||
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">    OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS </span></div> | ||||
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">    SOFTWARE.</span></div> | ||||
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">*/</span></div> | ||||
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div> | ||||
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#ifndef TMR2_H</span></div> | ||||
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#define TMR2_H</span></div> | ||||
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div> | ||||
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#include <stdint.h></span></div> | ||||
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#include <stdbool.h></span></div> | ||||
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div> | ||||
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">#ifdef __cplusplus  </span><span class="comment">// Provide C++ Compatibility</span></div> | ||||
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div> | ||||
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> | ||||
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div> | ||||
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">#endif</span></div> | ||||
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div> | ||||
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div> | ||||
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="keywordtype">void</span> <a class="code hl_function" href="tmr2_8h.html#a46c13c9255379e99c10240229a145d37">TMR2_Initialize</a>(<span class="keywordtype">void</span>);</div> | ||||
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div> | ||||
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="keywordtype">void</span> <a class="code hl_function" href="tmr2_8h.html#afb37b846db811f973b4009215d59f91a">TMR2_StartTimer</a>(<span class="keywordtype">void</span>);</div> | ||||
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span> </div> | ||||
| <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="keywordtype">void</span> <a class="code hl_function" href="tmr2_8h.html#a36d7e6eab8b279863c83a32fb41adb02">TMR2_StopTimer</a>(<span class="keywordtype">void</span>);</div> | ||||
| <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span> </div> | ||||
| <div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>uint8_t <a class="code hl_function" href="tmr2_8h.html#a4acc1f7c8c2dbd46424dad273cdb9cb1">TMR2_ReadTimer</a>(<span class="keywordtype">void</span>);</div> | ||||
| <div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span> </div> | ||||
| <div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="keywordtype">void</span> <a class="code hl_function" href="tmr2_8h.html#acb2fbe8254fcc8c01b9784b028a7eac6">TMR2_WriteTimer</a>(uint8_t timerVal);</div> | ||||
| <div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span> </div> | ||||
| <div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="keywordtype">void</span> <a class="code hl_function" href="tmr2_8h.html#a5490961ba3ba77d10896e320ab840a74">TMR2_LoadPeriodRegister</a>(uint8_t periodVal);</div> | ||||
| <div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span> </div> | ||||
| <div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="keywordtype">bool</span> <a class="code hl_function" href="tmr2_8h.html#ab0b9dbd90bacc904f311d71fbcccd038">TMR2_HasOverflowOccured</a>(<span class="keywordtype">void</span>);</div> | ||||
| <div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span> </div> | ||||
| <div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="preprocessor"> #ifdef __cplusplus  </span><span class="comment">// Provide C++ Compatibility</span></div> | ||||
| <div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span> </div> | ||||
| <div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span>    }</div> | ||||
| <div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span> </div> | ||||
| <div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="preprocessor">#endif</span></div> | ||||
| <div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span> </div> | ||||
| <div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="preprocessor">#endif </span><span class="comment">// TMR2_H</span></div> | ||||
| <div class="ttc" id="atmr2_8h_html_a36d7e6eab8b279863c83a32fb41adb02"><div class="ttname"><a href="tmr2_8h.html#a36d7e6eab8b279863c83a32fb41adb02">TMR2_StopTimer</a></div><div class="ttdeci">void TMR2_StopTimer(void)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00085">tmr2.c:85</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_a46c13c9255379e99c10240229a145d37"><div class="ttname"><a href="tmr2_8h.html#a46c13c9255379e99c10240229a145d37">TMR2_Initialize</a></div><div class="ttdeci">void TMR2_Initialize(void)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00062">tmr2.c:62</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_a4acc1f7c8c2dbd46424dad273cdb9cb1"><div class="ttname"><a href="tmr2_8h.html#a4acc1f7c8c2dbd46424dad273cdb9cb1">TMR2_ReadTimer</a></div><div class="ttdeci">uint8_t TMR2_ReadTimer(void)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00091">tmr2.c:91</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_a5490961ba3ba77d10896e320ab840a74"><div class="ttname"><a href="tmr2_8h.html#a5490961ba3ba77d10896e320ab840a74">TMR2_LoadPeriodRegister</a></div><div class="ttdeci">void TMR2_LoadPeriodRegister(uint8_t periodVal)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00106">tmr2.c:106</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_ab0b9dbd90bacc904f311d71fbcccd038"><div class="ttname"><a href="tmr2_8h.html#ab0b9dbd90bacc904f311d71fbcccd038">TMR2_HasOverflowOccured</a></div><div class="ttdeci">bool TMR2_HasOverflowOccured(void)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00111">tmr2.c:111</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_acb2fbe8254fcc8c01b9784b028a7eac6"><div class="ttname"><a href="tmr2_8h.html#acb2fbe8254fcc8c01b9784b028a7eac6">TMR2_WriteTimer</a></div><div class="ttdeci">void TMR2_WriteTimer(uint8_t timerVal)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00100">tmr2.c:100</a></div></div> | ||||
| <div class="ttc" id="atmr2_8h_html_afb37b846db811f973b4009215d59f91a"><div class="ttname"><a href="tmr2_8h.html#afb37b846db811f973b4009215d59f91a">TMR2_StartTimer</a></div><div class="ttdeci">void TMR2_StartTimer(void)</div><div class="ttdef"><b>Definition:</b> <a href="tmr2_8c_source.html#l00079">tmr2.c:79</a></div></div> | ||||
| </div><!-- fragment --></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="dir_0ad8aa10ae8c15a00cc43e117933779f.html">mcc_generated_files</a></li><li class="navelem"><a class="el" href="tmr2_8h.html">tmr2.h</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.6 </li> | ||||
|   </ul> | ||||
| </div> | ||||
| </body> | ||||
| </html> | ||||
		Reference in New Issue
	
	Block a user