Skip to content

Commit 5b20cc1

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent d233015 commit 5b20cc1

20 files changed

+786
-692
lines changed

‎docs/html/_a_a_c_decoder_helix_8h_source.html

Lines changed: 137 additions & 135 deletions
Large diffs are not rendered by default.

‎docs/html/_common_helix_8h_source.html

Lines changed: 202 additions & 180 deletions
Large diffs are not rendered by default.

‎docs/html/_config_helix_8h_source.html

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
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>Arduino LibHelix: src/ConfigHelix.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">Arduino LibHelix
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
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','.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: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 id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="headertitle">
69+
<div class="title">ConfigHelix.h</div> </div>
70+
</div><!--header-->
71+
<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">// Common</span></div>
75+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#ifndef SYNCH_WORD_LEN</span></div>
76+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor"># define SYNCH_WORD_LEN 4</span></div>
77+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#endif </span></div>
78+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
79+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef HELIX_CHUNK_SIZE</span></div>
80+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"># define HELIX_CHUNK_SIZE 1024</span></div>
81+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#endif</span></div>
82+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
83+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// mp3</span></div>
84+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef MP3_MAX_OUTPUT_SIZE</span></div>
85+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"># define MP3_MAX_OUTPUT_SIZE 1024 * 5</span></div>
86+
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#endif</span></div>
87+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#ifndef MP3_MAX_FRAME_SIZE</span></div>
88+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor"># define MP3_MAX_FRAME_SIZE 1024 * 2</span></div>
89+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#endif</span></div>
90+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef MP3_MIN_FRAME_SIZE</span></div>
91+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># define MP3_MIN_FRAME_SIZE 1024</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="comment">// aac</span></div>
95+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef AAC_MAX_OUTPUT_SIZE</span></div>
96+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># define AAC_MAX_OUTPUT_SIZE 1024 * 8</span></div>
97+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
98+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifndef AAC_MAX_FRAME_SIZE</span></div>
99+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor"># define AAC_MAX_FRAME_SIZE 2100</span></div>
100+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div>
101+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#ifndef AAC_MIN_FRAME_SIZE</span></div>
102+
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor"># define AAC_MIN_FRAME_SIZE 1024</span></div>
103+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div>
104+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
105+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">// Allocation: define allocator to be used</span></div>
106+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define ALLOCATOR libhelix::AllocatorExt</span></div>
107+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
108+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">// Logging: Activate/Deactivate logging</span></div>
109+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#if ! defined(HELIX_LOGGING_ACTIVE) &amp;&amp; defined(ARDUINO)</span></div>
110+
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor"># define HELIX_LOGGING_ACTIVE true</span></div>
111+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif</span></div>
112+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
113+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#ifndef HELIX_LOG_LEVEL</span></div>
114+
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor"># define HELIX_LOG_LEVEL LogLevelHelix::Warning</span></div>
115+
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#endif</span></div>
116+
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
117+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#ifndef LOG_METHOD</span></div>
118+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"># define LOG_METHOD __PRETTY_FUNCTION__</span></div>
119+
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#endif</span></div>
120+
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
121+
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#ifndef HELIX_LOGGING_OUT</span></div>
122+
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor"># define HELIX_LOGGING_OUT Serial</span></div>
123+
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif</span></div>
124+
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
125+
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#ifndef HELIX_LOG_SIZE</span></div>
126+
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor"># define HELIX_LOG_SIZE 256</span></div>
127+
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif</span></div>
128+
</div><!-- fragment --></div><!-- contents -->
129+
<!-- start footer part -->
130+
<hr class="footer"/><address class="footer"><small>
131+
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
132+
</small></address>
133+
</body>
134+
</html>

0 commit comments

Comments
 (0)