Skip to content

Commit 4219c3d

Browse files
tfry-gittfry-git
committed
Update API docs
1 parent f5807cd commit 4219c3d

File tree

548 files changed

+31639
-2376
lines changed

Some content is hidden

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

548 files changed

+31639
-2376
lines changed

‎EmbAJAX.h‎

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -188,40 +188,6 @@ class EmbAJAXOutputDriverBase {
188188
* See there for further info. This function is really just the internal implementation, public for technical reasons.
189189
*/
190190
void _printContentF(const char* fmt, ...);
191-
/** @def printFormatted(...)
192-
* Print a static string with parameters replaced, roughly similar to printf
193-
*
194-
* This is the primary function for elements to "print" to the client, i.e. to send the HTML/JS code needed to make
195-
* the element work. The usage may best be explained by example (actual code of EmbAJAXSlider:
196-
* @code{.cpp}
197-
* _driver->printFormatted("<input type=\"range\" id=", HTML_QUOTED_STRING(_id),
198-
* " min=", INTEGER_VALUE(_min), " max=", INTEGER_VALUE(_max),
199-
* " value=", INTEGER_VALUE(_value),
200-
* " oninput=\"doRequest(this.id, this.value);\" onchange=\"oninput();\"/>");
201-
* @endcode
202-
*
203-
* First thing to note is that - although this function is technically implemented as a macro - it behaves like a
204-
* public member function of EmbAJAXOutputDriverBase. Actually the macro relays to appropriate helper functions in that class.
205-
*
206-
* Arguments can be either string literals, or values. These two kinds of argument have to be used alternatingly (which is usually
207-
* needed, anyway), i.e. "string", value, "string", value... Values have to be wrapped by one of #HTML_QUOTED_STRING(), #INTEGER_VALUE(),
208-
* #HTML_ESCAPED_STRING, JS_QUOTED_STRING, PLAIN_STRING, which will control just how the value is inserted (with of without quotes, with
209-
* HTML entities escaped, etc.).
210-
*
211-
* Internally, all static portions of the output will be concatenated to a single string, which - on architectures where it matters -
212-
* will automatically be wrapped inside an F() macro, for storage in FLASH memory, thus helping a lot to reduce RAM usage (not yet implemented,
213-
* to come soon).
214-
*
215-
* For efficiency reasons, you should try to merge as many bits of output in a single printFormatted(), as possible. I.e. instead of
216-
* @code{.cpp}
217-
* _driver->printFormatted("id=", HTML_QUOTED_STRING(_id));
218-
* _driver->printFormatted(" value=", INTEGER_VALUE(_value));
219-
* @endcode
220-
* always use:
221-
* @code{.cpp}
222-
* _driver->printFormatted("id=", HTML_QUOTED_STRING(_id), _driver->printFormatted(" value=", INTEGER_VALUE(_value));
223-
* @endcode
224-
* */
225191
private:
226192
void _printFiltered(const char* value, QuoteMode quoted, bool HTMLescaped);
227193
void _printContent(const char* content);

‎docs/api.doxygen‎

Lines changed: 2658 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api/ChangeLog_8md.html‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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>EmbAJAX: ChangeLog.md 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">EmbAJAX
25+
</div>
26+
<div id="projectbrief">Simplistic framework for creating and handling displays and controls on a web page served by an embeddable device (Arduino or other microcontroller with Arduino support).</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.9.1 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */</script>
48+
<div id="main-nav"></div>
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><!-- top -->
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">ChangeLog.md File Reference</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
</div><!-- contents -->
70+
<!-- start footer part -->
71+
<hr class="footer"/><address class="footer"><small>
72+
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
73+
</small></address>
74+
</body>
75+
</html>

‎docs/api/EmbAJAXJoystick_8h.html‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
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>EmbAJAX: EmbAJAXJoystick.h 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">EmbAJAX
25+
</div>
26+
<div id="projectbrief">Simplistic framework for creating and handling displays and controls on a web page served by an embeddable device (Arduino or other microcontroller with Arduino support).</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.9.1 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */</script>
48+
<div id="main-nav"></div>
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><!-- top -->
64+
<div class="header">
65+
<div class="summary">
66+
<a href="#nested-classes">Classes</a> &#124;
67+
<a href="#var-members">Variables</a> </div>
68+
<div class="headertitle">
69+
<div class="title">EmbAJAXJoystick.h File Reference</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
<div class="textblock"><code>#include &quot;<a class="el" href="EmbAJAX_8h_source.html">EmbAJAX.h</a>&quot;</code><br />
73+
</div><div class="textblock"><div class="dynheader">
74+
Include dependency graph for EmbAJAXJoystick.h:</div>
75+
<div class="dyncontent">
76+
<div class="center"><img src="EmbAJAXJoystick_8h__incl.png" border="0" usemap="#aEmbAJAXJoystick_8h" alt=""/></div>
77+
<map name="aEmbAJAXJoystick_8h" id="aEmbAJAXJoystick_8h">
78+
<area shape="rect" title=" " alt="" coords="45,5,191,32"/>
79+
<area shape="rect" href="EmbAJAX_8h.html" title=" " alt="" coords="71,80,165,107"/>
80+
<area shape="rect" title=" " alt="" coords="5,155,89,181"/>
81+
<area shape="rect" href="macro__definitions_8h.html" title=" " alt="" coords="113,155,264,181"/>
82+
</map>
83+
</div>
84+
</div>
85+
<p><a href="EmbAJAXJoystick_8h_source.html">Go to the source code of this file.</a></p>
86+
<table class="memberdecls">
87+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
88+
Classes</h2></td></tr>
89+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEmbAJAXJoystick.html">EmbAJAXJoystick</a></td></tr>
90+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
91+
</table><table class="memberdecls">
92+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
93+
Variables</h2></td></tr>
94+
<tr class="memitem:a1c5f6350d69d85353c300955e7402511"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="EmbAJAXJoystick_8h.html#a1c5f6350d69d85353c300955e7402511">EmbAJAXJoystick_SNAP_BACK</a> [] = &quot;if (!pressed) { x = 0; y = 0; }\n&quot;</td></tr>
95+
<tr class="separator:a1c5f6350d69d85353c300955e7402511"><td class="memSeparator" colspan="2">&#160;</td></tr>
96+
<tr class="memitem:aa4ed3b75f730cb0e2c524766fbe3a8b4"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="EmbAJAXJoystick_8h.html#aa4ed3b75f730cb0e2c524766fbe3a8b4">EmbAJAXJoystick_NO_SNAP_BACK</a> [] = &quot;&quot;</td></tr>
97+
<tr class="separator:aa4ed3b75f730cb0e2c524766fbe3a8b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
98+
<tr class="memitem:ae1ded7830a1d64662b24d6b752b1b54d"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="EmbAJAXJoystick_8h.html#ae1ded7830a1d64662b24d6b752b1b54d">EmbAJAXJoystick_FREE_POSITION</a> [] = &quot;&quot;</td></tr>
99+
<tr class="separator:ae1ded7830a1d64662b24d6b752b1b54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
100+
<tr class="memitem:aa4247899e5498e58b0c0a0e1f00e3e5e"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="EmbAJAXJoystick_8h.html#aa4247899e5498e58b0c0a0e1f00e3e5e">EmbAJAXJoystick_POSITION_9_DIRECTIONS</a> []</td></tr>
101+
<tr class="separator:aa4247899e5498e58b0c0a0e1f00e3e5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
102+
</table>
103+
<h2 class="groupheader">Variable Documentation</h2>
104+
<a id="ae1ded7830a1d64662b24d6b752b1b54d"></a>
105+
<h2 class="memtitle"><span class="permalink"><a href="#ae1ded7830a1d64662b24d6b752b1b54d">&#9670;&nbsp;</a></span>EmbAJAXJoystick_FREE_POSITION</h2>
106+
107+
<div class="memitem">
108+
<div class="memproto">
109+
<table class="memname">
110+
<tr>
111+
<td class="memname">const char EmbAJAXJoystick_FREE_POSITION[] = &quot;&quot;</td>
112+
</tr>
113+
</table>
114+
</div><div class="memdoc">
115+
116+
</div>
117+
</div>
118+
<a id="aa4ed3b75f730cb0e2c524766fbe3a8b4"></a>
119+
<h2 class="memtitle"><span class="permalink"><a href="#aa4ed3b75f730cb0e2c524766fbe3a8b4">&#9670;&nbsp;</a></span>EmbAJAXJoystick_NO_SNAP_BACK</h2>
120+
121+
<div class="memitem">
122+
<div class="memproto">
123+
<table class="memname">
124+
<tr>
125+
<td class="memname">const char EmbAJAXJoystick_NO_SNAP_BACK[] = &quot;&quot;</td>
126+
</tr>
127+
</table>
128+
</div><div class="memdoc">
129+
130+
</div>
131+
</div>
132+
<a id="aa4247899e5498e58b0c0a0e1f00e3e5e"></a>
133+
<h2 class="memtitle"><span class="permalink"><a href="#aa4247899e5498e58b0c0a0e1f00e3e5e">&#9670;&nbsp;</a></span>EmbAJAXJoystick_POSITION_9_DIRECTIONS</h2>
134+
135+
<div class="memitem">
136+
<div class="memproto">
137+
<table class="memname">
138+
<tr>
139+
<td class="memname">const char EmbAJAXJoystick_POSITION_9_DIRECTIONS[]</td>
140+
</tr>
141+
</table>
142+
</div><div class="memdoc">
143+
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="stringliteral">&quot;if (pressed) {\n&quot;</span></div>
144+
<div class="line"> <span class="stringliteral">&quot; if (x &lt; -500) x = -1000;\n&quot;</span></div>
145+
<div class="line"> <span class="stringliteral">&quot; else if (x &gt; 500) x = 1000\n&quot;</span></div>
146+
<div class="line"> <span class="stringliteral">&quot; else x = 0;\n&quot;</span></div>
147+
<div class="line"> <span class="stringliteral">&quot;\n&quot;</span></div>
148+
<div class="line"> <span class="stringliteral">&quot; if (y &lt; -500) y = -1000;\n&quot;</span></div>
149+
<div class="line"> <span class="stringliteral">&quot; else if (y &gt; 500) y = 1000\n&quot;</span></div>
150+
<div class="line"> <span class="stringliteral">&quot; else y = 0;\n&quot;</span></div>
151+
<div class="line"> <span class="stringliteral">&quot;}\n&quot;</span></div>
152+
</div><!-- fragment -->
153+
</div>
154+
</div>
155+
<a id="a1c5f6350d69d85353c300955e7402511"></a>
156+
<h2 class="memtitle"><span class="permalink"><a href="#a1c5f6350d69d85353c300955e7402511">&#9670;&nbsp;</a></span>EmbAJAXJoystick_SNAP_BACK</h2>
157+
158+
<div class="memitem">
159+
<div class="memproto">
160+
<table class="memname">
161+
<tr>
162+
<td class="memname">const char EmbAJAXJoystick_SNAP_BACK[] = &quot;if (!pressed) { x = 0; y = 0; }\n&quot;</td>
163+
</tr>
164+
</table>
165+
</div><div class="memdoc">
166+
<p>EmbAJAX - Simplistic framework for creating and handling displays and controls on a WebPage served by an Arduino (or other small device).</p>
167+
<p>Copyright (C) 2018-2019 Thomas Friedrichsmeier</p>
168+
<p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
169+
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
170+
<p>You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
171+
172+
</div>
173+
</div>
174+
</div><!-- contents -->
175+
<!-- start footer part -->
176+
<hr class="footer"/><address class="footer"><small>
177+
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
178+
</small></address>
179+
</body>
180+
</html>

‎docs/api/EmbAJAXJoystick_8h__incl.png‎

8.45 KB
Loading

‎docs/api/EmbAJAXJoystick_8h_source.html‎

Lines changed: 174 additions & 20 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)