Skip to content

Commit b8932ca

Browse files
committed
doxygen
1 parent 8e88dc1 commit b8932ca

File tree

122 files changed

+2270
-2167
lines changed

Some content is hidden

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

122 files changed

+2270
-2167
lines changed

docs/html/_audio_board_8h_source.html

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

docs/html/_common_8h.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159
, <a class="el" href="group__enumerations.html#gad4b0ae616e0ce2bdb666f8e75ab686b2a22b65b9bffe0216e00cc6363d8bc8acd">I2S_RIGHT</a> = 2
160160
, <a class="el" href="group__enumerations.html#gad4b0ae616e0ce2bdb666f8e75ab686b2ad1bdd515df80c99f3068af41f20d5821">I2S_DSP</a> = 3
161161
, <br />
162-
&#160;&#160;<a class="el" href="group__enumerations.html#gad4b0ae616e0ce2bdb666f8e75ab686b2a3f6c6f8dc33ec5b79e7963b4dc28c3d3">TDM</a> = 4
162+
&#160;&#160;<a class="el" href="group__enumerations.html#gad4b0ae616e0ce2bdb666f8e75ab686b2a940f8b5320c62c0a369e9fb566d83ca4">I2S_TDM</a> = 4
163163
<br />
164164
}</td></tr>
165165
<tr class="memdesc:gad4b0ae616e0ce2bdb666f8e75ab686b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select I2S interface format for audio codec chip. <a href="group__enumerations.html#gad4b0ae616e0ce2bdb666f8e75ab686b2">More...</a><br /></td></tr>
@@ -179,14 +179,14 @@
179179
, <a class="el" href="group__audio__driver.html#ga57493d56aec72d0d539dced15a738c50aed383e892e1fff2ff92159e3c0546352">ADC_INPUT_DIFFERENCE</a>
180180
<br />
181181
}</td></tr>
182-
<tr class="memdesc:ga57493d56aec72d0d539dced15a738c50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select adc channel for input mic signal. <a href="group__audio__driver.html#ga57493d56aec72d0d539dced15a738c50">More...</a><br /></td></tr>
182+
<tr class="memdesc:ga57493d56aec72d0d539dced15a738c50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select adc for input mic signal. If the chip only has one ADC this might provide the functionality on the channel level. <a href="group__audio__driver.html#ga57493d56aec72d0d539dced15a738c50">More...</a><br /></td></tr>
183183
<tr class="separator:ga57493d56aec72d0d539dced15a738c50"><td class="memSeparator" colspan="2">&#160;</td></tr>
184184
<tr class="memitem:ga9144c83baaa7ebeaaecb236f9e21d264"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264">output_device_t</a> { <a class="el" href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264ab839e055e11786256cd328d1b754a190">DAC_OUTPUT_NONE</a> = 0x00
185185
, <a class="el" href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264a11a8487d0e17c9ac1d194c4f99974c85">DAC_OUTPUT_LINE1</a>
186186
, <a class="el" href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264ae7351d9cbd1c1c3cd76bf4665e8d0cca">DAC_OUTPUT_LINE2</a>
187187
, <a class="el" href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264a9f3f48105f92c53bfcc4d9546f666c43">DAC_OUTPUT_ALL</a>
188188
}</td></tr>
189-
<tr class="memdesc:ga9144c83baaa7ebeaaecb236f9e21d264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select channel for dac output. <a href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264">More...</a><br /></td></tr>
189+
<tr class="memdesc:ga9144c83baaa7ebeaaecb236f9e21d264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select individual dac for dac output. If the device has only one DAC this might provide the functionality channel level. <a href="group__audio__driver.html#ga9144c83baaa7ebeaaecb236f9e21d264">More...</a><br /></td></tr>
190190
<tr class="separator:ga9144c83baaa7ebeaaecb236f9e21d264"><td class="memSeparator" colspan="2">&#160;</td></tr>
191191
<tr class="memitem:ga69c4b817c522e31496b9b6b6cda2926d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__enumerations.html#ga69c4b817c522e31496b9b6b6cda2926d">sample_bits_t</a> { <br />
192192
&#160;&#160;<a class="el" href="group__enumerations.html#ga69c4b817c522e31496b9b6b6cda2926dadc61a4f3bf3ca7c35ea63e10bc5e2c76">BIT_LENGTH_MIN</a> = -1

docs/html/_common_8h_source.html

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

docs/html/_driver_8h_source.html

Lines changed: 1258 additions & 1243 deletions
Large diffs are not rendered by default.

docs/html/classaudio__driver_1_1_audio_driver_e_s8388_class-members.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@
9191
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#acd5d071057ce19f3718940329d202ef8">setInputVolume</a>(int volume)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
9292
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#aadd8a57d9981d793494b96bfc9939699">setMicrophoneGain</a>(es_mic_gain_t gain)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
9393
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#aa2a08d0fd7c4e897419766a5a0ebc291">setMute</a>(bool mute)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
94-
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">setPAPower</a>(bool enable)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver.html">AudioDriver</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
95-
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#ad7d51b9e21a345d836cb4cfe2df2152c">setVolume</a>(int volume)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
94+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#a59ea4d70e5093706baadc42b6854b6ab">setMute</a>(bool mute, int line)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
95+
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">setPAPower</a>(bool enable)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver.html">AudioDriver</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
96+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#ad7d51b9e21a345d836cb4cfe2df2152c">setVolume</a>(int volume)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html">AudioDriverES8388Class</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
9697
</table></div><!-- contents -->
9798
<!-- start footer part -->
9899
<hr class="footer"/><address class="footer"><small>

docs/html/classaudio__driver_1_1_audio_driver_e_s8388_class.html

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@
111111
<tr class="separator:aadd8a57d9981d793494b96bfc9939699"><td class="memSeparator" colspan="2">&#160;</td></tr>
112112
<tr class="memitem:aa2a08d0fd7c4e897419766a5a0ebc291"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#aa2a08d0fd7c4e897419766a5a0ebc291">setMute</a> (bool mute)</td></tr>
113113
<tr class="separator:aa2a08d0fd7c4e897419766a5a0ebc291"><td class="memSeparator" colspan="2">&#160;</td></tr>
114+
<tr class="memitem:a59ea4d70e5093706baadc42b6854b6ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_audio_driver_e_s8388_class.html#a59ea4d70e5093706baadc42b6854b6ab">setMute</a> (bool mute, int line)</td></tr>
115+
<tr class="separator:a59ea4d70e5093706baadc42b6854b6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
114116
<tr class="memitem:a1b3ee72f65915dcb4c875835d6e08aa1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">setPAPower</a> (bool enable)</td></tr>
115117
<tr class="memdesc:a1b3ee72f65915dcb4c875835d6e08aa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the PA Power pin to active or inactive. <a href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">More...</a><br /></td></tr>
116118
<tr class="separator:a1b3ee72f65915dcb4c875835d6e08aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -630,7 +632,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aadd8a57d9981d793494b96bf
630632
</div>
631633
</div>
632634
<a id="aa2a08d0fd7c4e897419766a5a0ebc291"></a>
633-
<h2 class="memtitle"><span class="permalink"><a href="#aa2a08d0fd7c4e897419766a5a0ebc291">&#9670;&nbsp;</a></span>setMute()</h2>
635+
<h2 class="memtitle"><span class="permalink"><a href="#aa2a08d0fd7c4e897419766a5a0ebc291">&#9670;&nbsp;</a></span>setMute() <span class="overload">[1/2]</span></h2>
634636

635637
<div class="memitem">
636638
<div class="memproto">
@@ -656,6 +658,44 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa2a08d0fd7c4e897419766a5
656658

657659
<p>Implements <a class="el" href="classaudio__driver_1_1_audio_driver.html#a0065b12757039a60467b6b12ccefc4ba">AudioDriver</a>.</p>
658660

661+
</div>
662+
</div>
663+
<a id="a59ea4d70e5093706baadc42b6854b6ab"></a>
664+
<h2 class="memtitle"><span class="permalink"><a href="#a59ea4d70e5093706baadc42b6854b6ab">&#9670;&nbsp;</a></span>setMute() <span class="overload">[2/2]</span></h2>
665+
666+
<div class="memitem">
667+
<div class="memproto">
668+
<table class="mlabels">
669+
<tr>
670+
<td class="mlabels-left">
671+
<table class="memname">
672+
<tr>
673+
<td class="memname">bool setMute </td>
674+
<td>(</td>
675+
<td class="paramtype">bool&#160;</td>
676+
<td class="paramname"><em>mute</em>, </td>
677+
</tr>
678+
<tr>
679+
<td class="paramkey"></td>
680+
<td></td>
681+
<td class="paramtype">int&#160;</td>
682+
<td class="paramname"><em>line</em>&#160;</td>
683+
</tr>
684+
<tr>
685+
<td></td>
686+
<td>)</td>
687+
<td></td><td></td>
688+
</tr>
689+
</table>
690+
</td>
691+
<td class="mlabels-right">
692+
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
693+
</tr>
694+
</table>
695+
</div><div class="memdoc">
696+
<p>&lt; error_t value indicating success (no error)</p>
697+
<p>&lt; error_t value indicating success (no error)</p>
698+
659699
</div>
660700
</div>
661701
<a id="a1b3ee72f65915dcb4c875835d6e08aa1"></a>

docs/html/classaudio__driver_1_1_codec_config-members.html

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,18 @@
7373
<p>This is the complete list of members for <a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a>, including all inherited members.</p>
7474
<table class="directory">
7575
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a0eced3855f21d967d42b4c399338d3bf">CodecConfig</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
76-
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a8fa9926c8f49782f025aa24180d4ca33">get_mode</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
77-
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#afb4dc267068aaa494327923fecec6b41">getBitsNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
78-
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ab1fb25acae6f8d20d0fd2243fdf731ab">getChannelsNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
79-
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a5a8e72d47263001aff56c9f4aa976fa4">getRateNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
80-
<tr><td class="entry"><a class="el" href="structcodec__config__t.html#aaf711847489250fbc86db83f79b01b2b">i2s</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
81-
<tr class="even"><td class="entry"><a class="el" href="structcodec__config__t.html#af1127704c2bde9a89bb0b092bfb13746">input_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
82-
<tr><td class="entry"><a class="el" href="structcodec__config__t.html#a53991a860287c34f4e412af745d4bb66">output_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
83-
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ac585b3449d271276f8b679e8ab01b2ec">sd_active</a></td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"></td></tr>
84-
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">setBitsNumeric</a>(int bits)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85-
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">setChannelsNumeric</a>(int channels)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
86-
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">setRateNumeric</a>(int rateNum)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
76+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#af79a2494e2c27af3418daf7ee490c413">equalsExRate</a>(CodecConfig alt)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
77+
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a8fa9926c8f49782f025aa24180d4ca33">get_mode</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
78+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#afb4dc267068aaa494327923fecec6b41">getBitsNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
79+
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ab1fb25acae6f8d20d0fd2243fdf731ab">getChannelsNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
80+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a5a8e72d47263001aff56c9f4aa976fa4">getRateNumeric</a>()</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
81+
<tr class="even"><td class="entry"><a class="el" href="structcodec__config__t.html#aaf711847489250fbc86db83f79b01b2b">i2s</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
82+
<tr><td class="entry"><a class="el" href="structcodec__config__t.html#af1127704c2bde9a89bb0b092bfb13746">input_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
83+
<tr class="even"><td class="entry"><a class="el" href="structcodec__config__t.html#a53991a860287c34f4e412af745d4bb66">output_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
84+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ac585b3449d271276f8b679e8ab01b2ec">sd_active</a></td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"></td></tr>
85+
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">setBitsNumeric</a>(int bits)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
86+
<tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">setChannelsNumeric</a>(int channels)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
87+
<tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">setRateNumeric</a>(int rateNum)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
8788
</table></div><!-- contents -->
8889
<!-- start footer part -->
8990
<hr class="footer"/><address class="footer"><small>

0 commit comments

Comments
 (0)