Skip to content

Commit 26270b1

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent 358506d commit 26270b1

File tree

410 files changed

+31496
-17595
lines changed

Some content is hidden

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

410 files changed

+31496
-17595
lines changed

‎docs/html/_a_p_i___g_p_i_o_8h.html‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>arduino-audio-driver: src/Platforms/API_GPIO.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 id="projectrow">
23+
<td id="projectalign">
24+
<div id="projectname">arduino-audio-driver
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.8 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35+
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */
47+
</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+
<div id="MSearchResults">
59+
<div class="SRPage">
60+
<div id="SRIndex">
61+
<div id="SRResults"></div>
62+
<div class="SRStatus" id="Loading">Loading...</div>
63+
<div class="SRStatus" id="Searching">Searching...</div>
64+
<div class="SRStatus" id="NoMatches">No Matches</div>
65+
</div>
66+
</div>
67+
</div>
68+
</div>
69+
70+
<div id="nav-path" class="navpath">
71+
<ul>
72+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_03d7d17aa0ae13f975c2241883b8df3e.html">Platforms</a></li> </ul>
73+
</div>
74+
</div><!-- top -->
75+
<div class="header">
76+
<div class="summary">
77+
<a href="#nested-classes">Classes</a> &#124;
78+
<a href="#namespaces">Namespaces</a> </div>
79+
<div class="headertitle"><div class="title">API_GPIO.h File Reference</div></div>
80+
</div><!--header-->
81+
<div class="contents">
82+
<div class="textblock"><code>#include &quot;<a class="el" href="_i_driver_pins_8h_source.html">IDriverPins.h</a>&quot;</code><br />
83+
</div>
84+
<p><a href="_a_p_i___g_p_i_o_8h_source.html">Go to the source code of this file.</a></p>
85+
<table class="memberdecls">
86+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
87+
Classes</h2></td></tr>
88+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html">API_GPIO</a></td></tr>
89+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
90+
</table><table class="memberdecls">
91+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
92+
Namespaces</h2></td></tr>
93+
<tr class="memitem:namespaceaudio__driver" id="r_namespaceaudio__driver"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaudio__driver.html">audio_driver</a></td></tr>
94+
<tr class="memdesc:namespaceaudio__driver"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for audio driver components. <br /></td></tr>
95+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
96+
</table>
97+
</div><!-- contents -->
98+
<!-- start footer part -->
99+
<hr class="footer"/><address class="footer"><small>
100+
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
101+
</small></address>
102+
</body>
103+
</html>

‎docs/html/_a_p_i___g_p_i_o_8h_source.html‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
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" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>arduino-audio-driver: src/Platforms/API_GPIO.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 id="projectrow">
23+
<td id="projectalign">
24+
<div id="projectname">arduino-audio-driver
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.8 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35+
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */
47+
</script>
48+
<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>
54+
<!-- window showing the filter options -->
55+
<div id="MSearchSelectWindow"
56+
onmouseover="return searchBox.OnSearchSelectShow()"
57+
onmouseout="return searchBox.OnSearchSelectHide()"
58+
onkeydown="return searchBox.OnSearchSelectKey(event)">
59+
</div>
60+
61+
<!-- iframe showing the search results (closed by default) -->
62+
<div id="MSearchResultsWindow">
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>
73+
</div>
74+
75+
<div id="nav-path" class="navpath">
76+
<ul>
77+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_03d7d17aa0ae13f975c2241883b8df3e.html">Platforms</a></li> </ul>
78+
</div>
79+
</div><!-- top -->
80+
<div class="header">
81+
<div class="headertitle"><div class="title">API_GPIO.h</div></div>
82+
</div><!--header-->
83+
<div class="contents">
84+
<a href="_a_p_i___g_p_i_o_8h.html">Go to the documentation of this file.</a><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><span class="preprocessor">#include &quot;<a class="code" href="_i_driver_pins_8h.html">IDriverPins.h</a>&quot;</span></div>
86+
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
87+
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaudio__driver.html">audio_driver</a> {</div>
88+
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
89+
<div class="foldopen" id="foldopen00006" data-start="{" data-end="};">
90+
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html"> 6</a></span><span class="keyword">class </span><a class="code hl_class" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html">API_GPIO</a> {</div>
91+
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">public</span>:</div>
92+
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a08c2138db21c484eec53095e889ef7a0"> 8</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a08c2138db21c484eec53095e889ef7a0">begin</a>(<a class="code hl_class" href="classaudio__driver_1_1_i_driver_pins.html">IDriverPins</a>&amp; pins) = 0;</div>
93+
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#aa540e86022c1f72380d1014d98f38f43"> 9</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#aa540e86022c1f72380d1014d98f38f43">end</a>() = 0;</div>
94+
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a49a5e1fa23e307d2279d9ccc9fc1e430"> 10</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a49a5e1fa23e307d2279d9ccc9fc1e430">pinMode</a>(<span class="keywordtype">int</span> pin, <span class="keywordtype">int</span> mode) = 0;</div>
95+
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a8183fa2068ad4077785b2c2f691905d8"> 11</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a8183fa2068ad4077785b2c2f691905d8">digitalWrite</a>(<span class="keywordtype">int</span> pin, <span class="keywordtype">bool</span> value) = 0;</div>
96+
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a2d5b4538eb3c38bc972d71871b31e512"> 12</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a2d5b4538eb3c38bc972d71871b31e512">digitalRead</a>(<span class="keywordtype">int</span> pin) = 0;</div>
97+
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>};</div>
98+
</div>
99+
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
100+
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>}</div>
101+
<div class="ttc" id="a_i_driver_pins_8h_html"><div class="ttname"><a href="_i_driver_pins_8h.html">IDriverPins.h</a></div></div>
102+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html">audio_driver::API_GPIO</a></div><div class="ttdef"><b>Definition</b> API_GPIO.h:6</div></div>
103+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html_a08c2138db21c484eec53095e889ef7a0"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a08c2138db21c484eec53095e889ef7a0">audio_driver::API_GPIO::begin</a></div><div class="ttdeci">virtual bool begin(IDriverPins &amp;pins)=0</div></div>
104+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html_a2d5b4538eb3c38bc972d71871b31e512"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a2d5b4538eb3c38bc972d71871b31e512">audio_driver::API_GPIO::digitalRead</a></div><div class="ttdeci">virtual bool digitalRead(int pin)=0</div></div>
105+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html_a49a5e1fa23e307d2279d9ccc9fc1e430"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a49a5e1fa23e307d2279d9ccc9fc1e430">audio_driver::API_GPIO::pinMode</a></div><div class="ttdeci">virtual void pinMode(int pin, int mode)=0</div></div>
106+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html_a8183fa2068ad4077785b2c2f691905d8"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#a8183fa2068ad4077785b2c2f691905d8">audio_driver::API_GPIO::digitalWrite</a></div><div class="ttdeci">virtual bool digitalWrite(int pin, bool value)=0</div></div>
107+
<div class="ttc" id="aclassaudio__driver_1_1_a_p_i___g_p_i_o_html_aa540e86022c1f72380d1014d98f38f43"><div class="ttname"><a href="classaudio__driver_1_1_a_p_i___g_p_i_o.html#aa540e86022c1f72380d1014d98f38f43">audio_driver::API_GPIO::end</a></div><div class="ttdeci">virtual void end()=0</div></div>
108+
<div class="ttc" id="aclassaudio__driver_1_1_i_driver_pins_html"><div class="ttname"><a href="classaudio__driver_1_1_i_driver_pins.html">audio_driver::IDriverPins</a></div><div class="ttdef"><b>Definition</b> IDriverPins.h:231</div></div>
109+
<div class="ttc" id="anamespaceaudio__driver_html"><div class="ttname"><a href="namespaceaudio__driver.html">audio_driver</a></div><div class="ttdoc">Namespace for audio driver components.</div><div class="ttdef"><b>Definition</b> AudioBoard.h:5</div></div>
110+
</div><!-- fragment --></div><!-- contents -->
111+
<!-- start footer part -->
112+
<hr class="footer"/><address class="footer"><small>
113+
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
114+
</small></address>
115+
</body>
116+
</html>

0 commit comments

Comments
 (0)