Skip to content

Commit ce166eb

Browse files
soundanalogoussoundanalogous
authored
Merge pull request #428 from mexchip/doxygen-docs
Set up API docs using Doxygen
2 parents 9868fbf + 3f417c1 commit ce166eb

File tree

108 files changed

+12901
-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.

108 files changed

+12901
-0
lines changed

‎docs/.nojekyll

Whitespace-only changes.

‎docs/Doxyfile

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

‎docs/html/_boards_8h_source.html

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

‎docs/html/_firmata_8h_source.html

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

‎docs/html/_firmata_constants_8h_source.html

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

‎docs/html/_firmata_defines_8h_source.html

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

‎docs/html/_firmata_marshaller_8h_source.html

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

‎docs/html/_firmata_parser_8h_source.html

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

‎docs/html/annotated.html

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
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.8.16"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Firmata firmware for Arduino: Class List</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">Firmata firmware for Arduino
25+
</div>
26+
<div id="projectbrief">Firmata is a protocol for communicating with microcontrollers from software on a host computer</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.16 -->
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');
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+
</div><!-- top -->
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">Class List</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
70+
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
71+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>firmata</b></td><td class="desc"></td></tr>
72+
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfirmata_1_1_firmata_class.html" target="_self">FirmataClass</a></td><td class="desc"></td></tr>
73+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfirmata_1_1_firmata_marshaller.html" target="_self">FirmataMarshaller</a></td><td class="desc"></td></tr>
74+
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfirmata_1_1_firmata_parser.html" target="_self">FirmataParser</a></td><td class="desc"></td></tr>
75+
</table>
76+
</div><!-- directory -->
77+
</div><!-- contents -->
78+
<!-- start footer part -->
79+
<hr class="footer"/><address class="footer"><small>
80+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
81+
<img class="footer" src="doxygen.png" alt="doxygen"/>
82+
</a> 1.8.16
83+
</small></address>
84+
</body>
85+
</html>

‎docs/html/bc_s.png

676 Bytes
Loading

‎docs/html/bdwn.png

147 Bytes
Loading

‎docs/html/classes.html

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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.8.16"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Firmata firmware for Arduino: Class Index</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">Firmata firmware for Arduino
25+
</div>
26+
<div id="projectbrief">Firmata is a protocol for communicating with microcontrollers from software on a host computer</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.16 -->
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');
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+
</div><!-- top -->
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">Class Index</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
<div class="qindex"><a class="qindex" href="#letter_f">f</a></div>
70+
<table class="classindex">
71+
<tr><td rowspan="2" valign="bottom"><a name="letter_f"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;f&#160;&#160;</div></td></tr></table>
72+
</td>
73+
<td valign="top"><a class="el" href="classfirmata_1_1_firmata_marshaller.html">FirmataMarshaller</a> (firmata)&#160;&#160;&#160;</td>
74+
<td valign="top"><a class="el" href="classfirmata_1_1_firmata_parser.html">FirmataParser</a> (firmata)&#160;&#160;&#160;</td>
75+
<td></td></tr>
76+
<tr><td></td><td></td><td></td></tr>
77+
<tr><td valign="top"><a class="el" href="classfirmata_1_1_firmata_class.html">FirmataClass</a> (firmata)&#160;&#160;&#160;</td>
78+
<td></td><td></td><td></td></tr>
79+
<tr><td></td><td></td><td></td><td></td></tr>
80+
</table>
81+
<div class="qindex"><a class="qindex" href="#letter_f">f</a></div>
82+
</div><!-- contents -->
83+
<!-- start footer part -->
84+
<hr class="footer"/><address class="footer"><small>
85+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
86+
<img class="footer" src="doxygen.png" alt="doxygen"/>
87+
</a> 1.8.16
88+
</small></address>
89+
</body>
90+
</html>

0 commit comments

Comments
 (0)