Skip to content

Commit 45015b3

Browse files
pschatzmannpschatzmann
committed
Improve documentation
1 parent a478d64 commit 45015b3

926 files changed

Lines changed: 63724 additions & 44827 deletions

File tree

Some content is hidden

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

‎ArduinoCore-Linux/cores/arduino/WiFiClient.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44

55
namespace arduino {
66

7+
/**
8+
* @brief Alias for EthernetClient to provide WiFiClient compatibility.
9+
*/
710
using WiFiClient = EthernetClient;
811

912
#if !defined(USE_HTTPS)
13+
/**
14+
* @brief Alias for EthernetClient to provide WiFiClientSecure compatibility when HTTPS is not used.
15+
*/
1016
using WiFiClientSecure = EthernetClient;
1117
#endif
1218
}

‎ArduinoCore-Linux/cores/arduino/WiFiServer.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
namespace arduino {
55

6+
/**
7+
* @brief Alias for EthernetServer to provide WiFiServer compatibility.
8+
*/
69
using WiFiServer = EthernetServer;
710

811
} // namespace arduino

‎ArduinoCore-Linux/cores/arduino/WiFiUDP.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
namespace arduino {
55

6+
/**
7+
* @brief Alias for EthernetUDP to provide WiFiUDP compatibility.
8+
*/
69
using WiFiUDP = EthernetUDP;
710

811
}

‎docs/html/_ard_file_stream_8h_source.html‎

Lines changed: 127 additions & 112 deletions
Large diffs are not rendered by default.

‎docs/html/_ard_stdio_8h_source.html‎

Lines changed: 149 additions & 132 deletions
Large diffs are not rendered by default.

‎docs/html/_arduino_8h_source.html‎

Lines changed: 75 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!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">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<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"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>arduino-emulator: ArduinoCore-Linux/cores/arduino/Arduino.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,8 +19,8 @@
1919
<div id="titlearea">
2020
<table cellspacing="0" cellpadding="0">
2121
<tbody>
22-
<tr style="height: 56px;">
23-
<td id="projectalign" style="padding-left: 0.5em;">
22+
<tr id="projectrow">
23+
<td id="projectalign">
2424
<div id="projectname">arduino-emulator
2525
</div>
2626
</td>
@@ -29,22 +29,28 @@
2929
</table>
3030
</div>
3131
<!-- end header part -->
32-
<!-- Generated by Doxygen 1.9.1 -->
32+
<!-- Generated by Doxygen 1.9.8 -->
3333
<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');
34+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35+
var searchBox = new SearchBox("searchBox", "search/",'.html');
3636
/* @license-end */
3737
</script>
3838
<script type="text/javascript" src="menudata.js"></script>
3939
<script type="text/javascript" src="menu.js"></script>
4040
<script type="text/javascript">
41-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4242
$(function() {
4343
initMenu('',true,false,'search.php','Search');
4444
$(document).ready(function() { init_search(); });
4545
});
46-
/* @license-end */</script>
46+
/* @license-end */
47+
</script>
4748
<div id="main-nav"></div>
49+
<script type="text/javascript">
50+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
51+
$(document).ready(function() { init_codefold(0); });
52+
/* @license-end */
53+
</script>
4854
<!-- window showing the filter options -->
4955
<div id="MSearchSelectWindow"
5056
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -54,9 +60,16 @@
5460

5561
<!-- iframe showing the search results (closed by default) -->
5662
<div id="MSearchResultsWindow">
57-
<iframe src="javascript:void(0)" frameborder="0"
58-
name="MSearchResults" id="MSearchResults">
59-
</iframe>
63+
<div id="MSearchResults">
64+
<div class="SRPage">
65+
<div id="SRIndex">
66+
<div id="SRResults"></div>
67+
<div class="SRStatus" id="Loading">Loading...</div>
68+
<div class="SRStatus" id="Searching">Searching...</div>
69+
<div class="SRStatus" id="NoMatches">No Matches</div>
70+
</div>
71+
</div>
72+
</div>
6073
</div>
6174

6275
<div id="nav-path" class="navpath">
@@ -65,43 +78,60 @@
6578
</div>
6679
</div><!-- top -->
6780
<div class="header">
68-
<div class="headertitle">
69-
<div class="title">Arduino.h</div> </div>
81+
<div class="headertitle"><div class="title">Arduino.h</div></div>
7082
</div><!--header-->
7183
<div class="contents">
72-
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
73-
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
74-
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">/*</span></div>
75-
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Arduino.h - Main include file for the Arduino SDK</span></div>
76-
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> Copyright (c) 2005-2013 Arduino Team. All right reserved.</span></div>
77-
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> This library is free software; you can redistribute it and/or</span></div>
78-
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
79-
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> License as published by the Free Software Foundation; either</span></div>
80-
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
81-
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
82-
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
83-
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
84-
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> Lesser General Public License for more details.</span></div>
85-
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
86-
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> License along with this library; if not, write to the Free Software</span></div>
87-
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
88-
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
89-
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
90-
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef HOST</span></div>
91-
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define HOST</span></div>
92-
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
93-
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
94-
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;ArduinoAPI.h&quot;</span></div>
95-
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;ArdStdio.h&quot;</span></div>
96-
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;ArduinoLogger.h&quot;</span></div>
97-
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;HardwareSetup.h&quot;</span></div>
98-
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;Serial.h&quot;</span></div>
99-
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;RemoteSerial.h&quot;</span></div>
100-
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
84+
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
85+
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
86+
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">/*</span></div>
87+
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Arduino.h - Main include file for the Arduino SDK</span></div>
88+
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> Copyright (c) 2005-2013 Arduino Team. All right reserved.</span></div>
89+
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> This library is free software; you can redistribute it and/or</span></div>
90+
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
91+
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> License as published by the Free Software Foundation; either</span></div>
92+
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
93+
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
94+
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
95+
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
96+
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> Lesser General Public License for more details.</span></div>
97+
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
98+
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> License along with this library; if not, write to the Free Software</span></div>
99+
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
100+
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
101+
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
102+
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef HOST</span></div>
103+
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor"># define HOST</span></div>
104+
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#endif</span></div>
105+
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
106+
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#if defined(_MSC_VER) &amp;&amp; !defined(M_PI) &amp;&amp; !defined(_USE_MATH_DEFINES)</span></div>
107+
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#define _USE_MATH_DEFINES </span><span class="comment">// to provide const like M_PI via &lt;math.h&gt;</span></div>
108+
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#endif</span></div>
109+
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
110+
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#if defined(_MSC_VER)</span></div>
111+
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Not available under MSVC</span></div>
112+
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#define __attribute__(x) </span><span class="comment">// nothing</span></div>
113+
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define __builtin_constant_p(x) (0) </span><span class="comment">// non-constant</span></div>
114+
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#endif</span></div>
115+
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
116+
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#if defined(_MSC_VER)</span></div>
117+
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// Temporary unsupported under Win/MSVC</span></div>
118+
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#define PROVIDE_HARDWARE_SETUP_SKIP</span></div>
119+
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#define PROVIDE_HARDWARE_WIFI_SKIP</span></div>
120+
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#endif</span></div>
121+
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
122+
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#include &quot;ArduinoAPI.h&quot;</span></div>
123+
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#include &quot;ArdStdio.h&quot;</span></div>
124+
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#include &quot;ArduinoLogger.h&quot;</span></div>
125+
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#include &quot;HardwareSetup.h&quot;</span></div>
126+
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#include &quot;Serial.h&quot;</span></div>
127+
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#include &quot;RemoteSerial.h&quot;</span></div>
128+
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
129+
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacearduino.html">arduino</a>;</div>
130+
<div class="ttc" id="anamespacearduino_html"><div class="ttname"><a href="namespacearduino.html">arduino</a></div><div class="ttdoc">We provide the WiFi class to simulate the Arduino WIFI. In in Linux we can expect that networking is ...</div><div class="ttdef"><b>Definition</b> Client.h:25</div></div>
101131
</div><!-- fragment --></div><!-- contents -->
102132
<!-- start footer part -->
103133
<hr class="footer"/><address class="footer"><small>
104-
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
134+
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.8
105135
</small></address>
106136
</body>
107137
</html>

0 commit comments

Comments
 (0)