Skip to content

Commit 5575a11

Browse files
3d-gussner3d-gussner
committed
Inital doxygen
1 parent ee067af commit 5575a11

File tree

925 files changed

+80252
-0
lines changed

Some content is hidden

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

925 files changed

+80252
-0
lines changed

‎BlinkM_8h_source.html‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Prusa3d Marlin fork: BlinkM.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Prusa3d Marlin fork
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
</div><!-- top -->
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">BlinkM.h</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
69+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> BlinkM.h</span></div>
70+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> Library header file for BlinkM library</span></div>
71+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
72+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#if (ARDUINO &gt;= 100)</span></div>
73+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor"> # include &quot;Arduino.h&quot;</span></div>
74+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#else</span></div>
75+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"> # include &quot;WProgram.h&quot;</span></div>
76+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#endif</span></div>
77+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
78+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;Wire.h&quot;</span></div>
79+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
80+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keywordtype">void</span> SendColors(<span class="keywordtype">byte</span> red, <span class="keywordtype">byte</span> grn, <span class="keywordtype">byte</span> blu);</div>
81+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
82+
</div><!-- fragment --></div><!-- contents -->
83+
<!-- start footer part -->
84+
<hr class="footer"/><address class="footer"><small>
85+
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.1
86+
</small></address>
87+
</body>
88+
</html>

‎ConfigurationStore_8cpp.html‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Prusa3d Marlin fork: ConfigurationStore.cpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Prusa3d Marlin fork
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
</div><!-- top -->
63+
<div class="header">
64+
<div class="summary">
65+
<a href="#func-members">Functions</a> &#124;
66+
<a href="#var-members">Variables</a> </div>
67+
<div class="headertitle">
68+
<div class="title">ConfigurationStore.cpp File Reference</div> </div>
69+
</div><!--header-->
70+
<div class="contents">
71+
<table class="memberdecls">
72+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
73+
Functions</h2></td></tr>
74+
<tr class="memitem:ae472bbff9efc5cf756b42045cfcdd874"><td class="memItemLeft" align="right" valign="top"><a id="ae472bbff9efc5cf756b42045cfcdd874"></a>
75+
void&#160;</td><td class="memItemRight" valign="bottom"><b>Config_PrintSettings</b> (uint8_t level)</td></tr>
76+
<tr class="separator:ae472bbff9efc5cf756b42045cfcdd874"><td class="memSeparator" colspan="2">&#160;</td></tr>
77+
<tr class="memitem:a1d77211b976613a4f0461e593aaae944"><td class="memItemLeft" align="right" valign="top"><a id="a1d77211b976613a4f0461e593aaae944"></a>
78+
void&#160;</td><td class="memItemRight" valign="bottom"><b>Config_StoreSettings</b> ()</td></tr>
79+
<tr class="separator:a1d77211b976613a4f0461e593aaae944"><td class="memSeparator" colspan="2">&#160;</td></tr>
80+
<tr class="memitem:a318cc1cddf128b2cf1fe55f7ab411319"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ConfigurationStore_8cpp.html#a318cc1cddf128b2cf1fe55f7ab411319">Config_RetrieveSettings</a> ()</td></tr>
81+
<tr class="memdesc:a318cc1cddf128b2cf1fe55f7ab411319"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read M500 configuration. <a href="ConfigurationStore_8cpp.html#a318cc1cddf128b2cf1fe55f7ab411319">More...</a><br /></td></tr>
82+
<tr class="separator:a318cc1cddf128b2cf1fe55f7ab411319"><td class="memSeparator" colspan="2">&#160;</td></tr>
83+
<tr class="memitem:aad1761efc0e576a74b00f42bcf348690"><td class="memItemLeft" align="right" valign="top"><a id="aad1761efc0e576a74b00f42bcf348690"></a>
84+
void&#160;</td><td class="memItemRight" valign="bottom"><b>Config_ResetDefault</b> ()</td></tr>
85+
<tr class="separator:aad1761efc0e576a74b00f42bcf348690"><td class="memSeparator" colspan="2">&#160;</td></tr>
86+
</table><table class="memberdecls">
87+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
88+
Variables</h2></td></tr>
89+
<tr class="memitem:ae387133b6b03537ddc0ac7e7be725879"><td class="memItemLeft" align="right" valign="top"><a id="ae387133b6b03537ddc0ac7e7be725879"></a>
90+
<a class="el" href="structM500__conf.html">M500_conf</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cs</b></td></tr>
91+
<tr class="separator:ae387133b6b03537ddc0ac7e7be725879"><td class="memSeparator" colspan="2">&#160;</td></tr>
92+
<tr class="memitem:a5a80fb5113a79d2f6ad2fc90d33dbf0b"><td class="memItemLeft" align="right" valign="top"><a id="a5a80fb5113a79d2f6ad2fc90d33dbf0b"></a>
93+
static const <a class="el" href="structM500__conf.html">M500_conf</a> default_conf&#160;</td><td class="memItemRight" valign="bottom"><b>PROGMEM</b></td></tr>
94+
<tr class="separator:a5a80fb5113a79d2f6ad2fc90d33dbf0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
95+
</table>
96+
<h2 class="groupheader">Function Documentation</h2>
97+
<a id="a318cc1cddf128b2cf1fe55f7ab411319"></a>
98+
<h2 class="memtitle"><span class="permalink"><a href="#a318cc1cddf128b2cf1fe55f7ab411319">&#9670;&nbsp;</a></span>Config_RetrieveSettings()</h2>
99+
100+
<div class="memitem">
101+
<div class="memproto">
102+
<table class="memname">
103+
<tr>
104+
<td class="memname">FORCE_INLINE void Config_RetrieveSettings </td>
105+
<td>(</td>
106+
<td class="paramname"></td><td>)</td>
107+
<td></td>
108+
</tr>
109+
</table>
110+
</div><div class="memdoc">
111+
<dl class="retval"><dt>Return values</dt><dd>
112+
<table class="retval">
113+
<tr><td class="paramname">true</td><td>Succeeded. Stored settings retrieved or default settings retrieved in case EEPROM cs was empty. </td></tr>
114+
<tr><td class="paramname">false</td><td>Failed. Default settings has been retrieved, because of version mismatch </td></tr>
115+
</table>
116+
</dd>
117+
</dl>
118+
119+
</div>
120+
</div>
121+
</div><!-- contents -->
122+
<!-- start footer part -->
123+
<hr class="footer"/><address class="footer"><small>
124+
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.1
125+
</small></address>
126+
</body>
127+
</html>

0 commit comments

Comments
 (0)