Skip to content

Commit ef7998c

Browse files
tobiasschuergtobiasschuerg
committed
Added doxygen documentation.
1 parent e9d9833 commit ef7998c

Some content is hidden

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

84 files changed

+7839
-0
lines changed

‎Doxyfile

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

‎html/_influx_data_8h.html

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP8266 InfluxDb: InfluxData.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">ESP8266 InfluxDb
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.14 -->
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');
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="#nested-classes">Classes</a> </div>
66+
<div class="headertitle">
67+
<div class="title">InfluxData.h File Reference</div> </div>
68+
</div><!--header-->
69+
<div class="contents">
70+
71+
<p><a href="_influx_data_8h_source.html">Go to the source code of this file.</a></p>
72+
<table class="memberdecls">
73+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
74+
Classes</h2></td></tr>
75+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_influx_data.html">InfluxData</a></td></tr>
76+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
77+
</table>
78+
</div><!-- contents -->
79+
<!-- start footer part -->
80+
<hr class="footer"/><address class="footer"><small>
81+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
82+
<img class="footer" src="doxygen.png" alt="doxygen"/>
83+
</a> 1.8.14
84+
</small></address>
85+
</body>
86+
</html>

‎html/_influx_data_8h_source.html

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP8266 InfluxDb: InfluxData.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">ESP8266 InfluxDb
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.14 -->
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');
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">InfluxData.h</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<a href="_influx_data_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00002"></a><span class="lineno"><a class="line" href="class_influx_data.html"> 2</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_influx_data.html">InfluxData</a></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;{</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="class_influx_data.html#a5b2ad5b02681f8e94fa5c1961ae329ee"> 6</a></span>&#160; <a class="code" href="class_influx_data.html#a5b2ad5b02681f8e94fa5c1961ae329ee">InfluxData</a>(String measurement) : _measurement(measurement) {}</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_influx_data.html#ac915e23779e8c6586474f52411b9e99c"> 8</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_influx_data.html#ac915e23779e8c6586474f52411b9e99c">addTag</a>(String key, String value)</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; _tags += <span class="stringliteral">&quot;,&quot;</span> + key + <span class="stringliteral">&quot;=&quot;</span> + value;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; }</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_influx_data.html#a0c513c9ce80a097203e335548548655a"> 12</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_influx_data.html#a0c513c9ce80a097203e335548548655a">addValue</a>(String key, <span class="keywordtype">float</span> value)</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; _values = (_values == <span class="stringliteral">&quot;&quot;</span>) ? (<span class="stringliteral">&quot; &quot;</span>) : (_values += <span class="stringliteral">&quot;,&quot;</span>);</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; _values += key + <span class="stringliteral">&quot;=&quot;</span> + String(value);</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; }</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_influx_data.html#afc25b6070ed558bbb765c9dbc5db0ec0"> 18</a></span>&#160; String <a class="code" href="class_influx_data.html#afc25b6070ed558bbb765c9dbc5db0ec0">toString</a>()</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">return</span> _measurement + _tags + _values;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; }</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; String _measurement;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; String _tags;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; String _values;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;};</div><div class="ttc" id="class_influx_data_html_ac915e23779e8c6586474f52411b9e99c"><div class="ttname"><a href="class_influx_data.html#ac915e23779e8c6586474f52411b9e99c">InfluxData::addTag</a></div><div class="ttdeci">void addTag(String key, String value)</div><div class="ttdef"><b>Definition:</b> InfluxData.h:8</div></div>
69+
<div class="ttc" id="class_influx_data_html_a0c513c9ce80a097203e335548548655a"><div class="ttname"><a href="class_influx_data.html#a0c513c9ce80a097203e335548548655a">InfluxData::addValue</a></div><div class="ttdeci">void addValue(String key, float value)</div><div class="ttdef"><b>Definition:</b> InfluxData.h:12</div></div>
70+
<div class="ttc" id="class_influx_data_html_a5b2ad5b02681f8e94fa5c1961ae329ee"><div class="ttname"><a href="class_influx_data.html#a5b2ad5b02681f8e94fa5c1961ae329ee">InfluxData::InfluxData</a></div><div class="ttdeci">InfluxData(String measurement)</div><div class="ttdef"><b>Definition:</b> InfluxData.h:6</div></div>
71+
<div class="ttc" id="class_influx_data_html"><div class="ttname"><a href="class_influx_data.html">InfluxData</a></div><div class="ttdef"><b>Definition:</b> InfluxData.h:2</div></div>
72+
<div class="ttc" id="class_influx_data_html_afc25b6070ed558bbb765c9dbc5db0ec0"><div class="ttname"><a href="class_influx_data.html#afc25b6070ed558bbb765c9dbc5db0ec0">InfluxData::toString</a></div><div class="ttdeci">String toString()</div><div class="ttdef"><b>Definition:</b> InfluxData.h:18</div></div>
73+
</div><!-- fragment --></div><!-- contents -->
74+
<!-- start footer part -->
75+
<hr class="footer"/><address class="footer"><small>
76+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
77+
<img class="footer" src="doxygen.png" alt="doxygen"/>
78+
</a> 1.8.14
79+
</small></address>
80+
</body>
81+
</html>

‎html/_influx_db_8cpp.html

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP8266 InfluxDb: InfluxDb.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">ESP8266 InfluxDb
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.14 -->
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');
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="headertitle">
65+
<div class="title">InfluxDb.cpp File Reference</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<div class="textblock"><code>#include &quot;Arduino.h&quot;</code><br />
69+
<code>#include &quot;<a class="el" href="_influx_db_8h_source.html">InfluxDb.h</a>&quot;</code><br />
70+
</div></div><!-- contents -->
71+
<!-- start footer part -->
72+
<hr class="footer"/><address class="footer"><small>
73+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
74+
<img class="footer" src="doxygen.png" alt="doxygen"/>
75+
</a> 1.8.14
76+
</small></address>
77+
</body>
78+
</html>

‎html/_influx_db_8h.html

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ESP8266 InfluxDb: InfluxDb.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">ESP8266 InfluxDb
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.14 -->
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');
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="#nested-classes">Classes</a> </div>
66+
<div class="headertitle">
67+
<div class="title">InfluxDb.h File Reference</div> </div>
68+
</div><!--header-->
69+
<div class="contents">
70+
<div class="textblock"><code>#include &quot;Arduino.h&quot;</code><br />
71+
<code>#include &lt;ESP8266HTTPClient.h&gt;</code><br />
72+
<code>#include &quot;<a class="el" href="_influx_data_8h_source.html">InfluxData.h</a>&quot;</code><br />
73+
</div>
74+
<p><a href="_influx_db_8h_source.html">Go to the source code of this file.</a></p>
75+
<table class="memberdecls">
76+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
77+
Classes</h2></td></tr>
78+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_influxdb.html">Influxdb</a></td></tr>
79+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
80+
</table>
81+
</div><!-- contents -->
82+
<!-- start footer part -->
83+
<hr class="footer"/><address class="footer"><small>
84+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
85+
<img class="footer" src="doxygen.png" alt="doxygen"/>
86+
</a> 1.8.14
87+
</small></address>
88+
</body>
89+
</html>

0 commit comments

Comments
 (0)