Skip to content

Commit e86ab93

Browse files
pschatzmannpschatzmann
committed
Fix broken doxygen
1 parent e023cb0 commit e86ab93

File tree

105 files changed

+5715
-3358
lines changed

Some content is hidden

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

105 files changed

+5715
-3358
lines changed

‎Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2216,7 +2216,7 @@ INCLUDE_FILE_PATTERNS =
22162216
# recursively expanded use the := operator instead of the = operator.
22172217
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
22182218

2219-
PREDEFINED = ESP_IDF_4 ARDUINO A2DP_I2S_AUDIOTOOLS
2219+
PREDEFINED = ESP_IDF_4 ARDUINO A2DP_I2S_AUDIOTOOLS CONFIG_IDF_TARGET_ESP32 IS_VALID_PLATFORM
22202220

22212221
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
22222222
# tag can be used to specify a list of macro names that should be expanded. The

‎docs/html/_bluetooth_a2_d_p_common_8h.html‎

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,137 @@
7474
</div><!-- top -->
7575
<div class="header">
7676
<div class="summary">
77-
<a href="#define-members">Macros</a> </div>
77+
<a href="#nested-classes">Classes</a> &#124;
78+
<a href="#define-members">Macros</a> &#124;
79+
<a href="#typedef-members">Typedefs</a> &#124;
80+
<a href="#enum-members">Enumerations</a> &#124;
81+
<a href="#func-members">Functions</a> &#124;
82+
<a href="#var-members">Variables</a> </div>
7883
<div class="headertitle"><div class="title">BluetoothA2DPCommon.h File Reference</div></div>
7984
</div><!--header-->
8085
<div class="contents">
81-
86+
<div class="textblock"><code>#include &quot;config.h&quot;</code><br />
87+
<code>#include &lt;math.h&gt;</code><br />
88+
<code>#include &lt;stdbool.h&gt;</code><br />
89+
<code>#include &lt;stdint.h&gt;</code><br />
90+
<code>#include &lt;stdio.h&gt;</code><br />
91+
<code>#include &lt;stdlib.h&gt;</code><br />
92+
<code>#include &lt;string.h&gt;</code><br />
93+
<code>#include &lt;unistd.h&gt;</code><br />
94+
<code>#include &lt;vector&gt;</code><br />
95+
<code>#include &quot;esp_idf_version.h&quot;</code><br />
96+
<code>#include &quot;freertos/FreeRTOS.h&quot;</code><br />
97+
<code>#include &quot;freertos/FreeRTOSConfig.h&quot;</code><br />
98+
<code>#include &quot;freertos/queue.h&quot;</code><br />
99+
<code>#include &quot;freertos/task.h&quot;</code><br />
100+
<code>#include &quot;freertos/timers.h&quot;</code><br />
101+
<code>#include &quot;xtensa_api.h&quot;</code><br />
102+
<code>#include &quot;A2DPVolumeControl.h&quot;</code><br />
103+
<code>#include &quot;esp_a2dp_api.h&quot;</code><br />
104+
<code>#include &quot;esp_avrc_api.h&quot;</code><br />
105+
<code>#include &quot;esp_bt.h&quot;</code><br />
106+
<code>#include &quot;esp_bt_device.h&quot;</code><br />
107+
<code>#include &quot;esp_bt_main.h&quot;</code><br />
108+
<code>#include &quot;esp_gap_bt_api.h&quot;</code><br />
109+
<code>#include &quot;esp_spp_api.h&quot;</code><br />
110+
<code>#include &quot;esp_task_wdt.h&quot;</code><br />
111+
<code>#include &quot;esp_timer.h&quot;</code><br />
112+
<code>#include &quot;nvs.h&quot;</code><br />
113+
<code>#include &quot;nvs_flash.h&quot;</code><br />
114+
<code>#include &quot;esp_log.h&quot;</code><br />
115+
</div>
82116
<p><a href="_bluetooth_a2_d_p_common_8h_source.html">Go to the source code of this file.</a></p>
83117
<table class="memberdecls">
118+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
119+
Classes</h2></td></tr>
120+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_a2_d_p_common.html">BluetoothA2DPCommon</a></td></tr>
121+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common Bluetooth A2DP functions. <a href="class_bluetooth_a2_d_p_common.html#details">More...</a><br /></td></tr>
122+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
123+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbt__app__msg__t.html">bt_app_msg_t</a></td></tr>
124+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal message to be sent for <a class="el" href="class_bluetooth_a2_d_p_sink.html" title="A2DP Bluethooth Sink - We initialize and start the Bluetooth A2DP Sink. The example https://github....">BluetoothA2DPSink</a> and <a class="el" href="class_bluetooth_a2_d_p_source.html" title="A2DP Bluetooth Source.">BluetoothA2DPSource</a>. <a href="structbt__app__msg__t.html#details">More...</a><br /></td></tr>
125+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
126+
</table><table class="memberdecls">
84127
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
85128
Macros</h2></td></tr>
129+
<tr class="memitem:adb68ab4b3a1950c74c1332eb7f64d707" id="r_adb68ab4b3a1950c74c1332eb7f64d707"><td class="memItemLeft" align="right" valign="top"><a id="adb68ab4b3a1950c74c1332eb7f64d707" name="adb68ab4b3a1950c74c1332eb7f64d707"></a>
130+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>A2DP_DEPRECATED</b>&#160;&#160;&#160;__attribute__((deprecated))</td></tr>
131+
<tr class="separator:adb68ab4b3a1950c74c1332eb7f64d707"><td class="memSeparator" colspan="2">&#160;</td></tr>
132+
<tr class="memitem:afd53be7e960fd8703890d394d8dda41d" id="r_afd53be7e960fd8703890d394d8dda41d"><td class="memItemLeft" align="right" valign="top"><a id="afd53be7e960fd8703890d394d8dda41d" name="afd53be7e960fd8703890d394d8dda41d"></a>
133+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>APP_RC_CT_TL_GET_CAPS</b>&#160;&#160;&#160;(0)</td></tr>
134+
<tr class="separator:afd53be7e960fd8703890d394d8dda41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135+
<tr class="memitem:a62ba9a3b2042befda829c741c29d6bc1" id="r_a62ba9a3b2042befda829c741c29d6bc1"><td class="memItemLeft" align="right" valign="top"><a id="a62ba9a3b2042befda829c741c29d6bc1" name="a62ba9a3b2042befda829c741c29d6bc1"></a>
136+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>APP_RC_CT_TL_GET_META_DATA</b>&#160;&#160;&#160;(1)</td></tr>
137+
<tr class="separator:a62ba9a3b2042befda829c741c29d6bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
138+
<tr class="memitem:ae1d078c796ab2ba702d38b72f882784a" id="r_ae1d078c796ab2ba702d38b72f882784a"><td class="memItemLeft" align="right" valign="top"><a id="ae1d078c796ab2ba702d38b72f882784a" name="ae1d078c796ab2ba702d38b72f882784a"></a>
139+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>APP_RC_CT_TL_RN_PLAY_POS_CHANGE</b>&#160;&#160;&#160;(4)</td></tr>
140+
<tr class="separator:ae1d078c796ab2ba702d38b72f882784a"><td class="memSeparator" colspan="2">&#160;</td></tr>
141+
<tr class="memitem:a39915d96e3ccaedd461897f72e50d237" id="r_a39915d96e3ccaedd461897f72e50d237"><td class="memItemLeft" align="right" valign="top"><a id="a39915d96e3ccaedd461897f72e50d237" name="a39915d96e3ccaedd461897f72e50d237"></a>
142+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>APP_RC_CT_TL_RN_PLAYBACK_CHANGE</b>&#160;&#160;&#160;(3)</td></tr>
143+
<tr class="separator:a39915d96e3ccaedd461897f72e50d237"><td class="memSeparator" colspan="2">&#160;</td></tr>
144+
<tr class="memitem:a8537f6338dbd1e9ffe44147a3a134eaf" id="r_a8537f6338dbd1e9ffe44147a3a134eaf"><td class="memItemLeft" align="right" valign="top"><a id="a8537f6338dbd1e9ffe44147a3a134eaf" name="a8537f6338dbd1e9ffe44147a3a134eaf"></a>
145+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>APP_RC_CT_TL_RN_TRACK_CHANGE</b>&#160;&#160;&#160;(2)</td></tr>
146+
<tr class="separator:a8537f6338dbd1e9ffe44147a3a134eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
147+
<tr class="memitem:a2a67368759c5f1d7a1ba512b038692f9" id="r_a2a67368759c5f1d7a1ba512b038692f9"><td class="memItemLeft" align="right" valign="top"><a id="a2a67368759c5f1d7a1ba512b038692f9" name="a2a67368759c5f1d7a1ba512b038692f9"></a>
148+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BT_APP_SIG_WORK_DISPATCH</b>&#160;&#160;&#160;(0x01)</td></tr>
149+
<tr class="separator:a2a67368759c5f1d7a1ba512b038692f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
150+
<tr class="memitem:afdb3a069ade7c8551e6ddfa31a7fc19a" id="r_afdb3a069ade7c8551e6ddfa31a7fc19a"><td class="memItemLeft" align="right" valign="top"><a id="afdb3a069ade7c8551e6ddfa31a7fc19a" name="afdb3a069ade7c8551e6ddfa31a7fc19a"></a>
151+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BT_APP_TAG</b>&#160;&#160;&#160;&quot;BT_API&quot;</td></tr>
152+
<tr class="separator:afdb3a069ade7c8551e6ddfa31a7fc19a"><td class="memSeparator" colspan="2">&#160;</td></tr>
153+
<tr class="memitem:a6f966f5c35766566f8815bec494fbdda" id="r_a6f966f5c35766566f8815bec494fbdda"><td class="memItemLeft" align="right" valign="top"><a id="a6f966f5c35766566f8815bec494fbdda" name="a6f966f5c35766566f8815bec494fbdda"></a>
154+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BT_AV_TAG</b>&#160;&#160;&#160;&quot;BT_AV&quot;</td></tr>
155+
<tr class="separator:a6f966f5c35766566f8815bec494fbdda"><td class="memSeparator" colspan="2">&#160;</td></tr>
156+
<tr class="memitem:aa87c1f9c93e7fd1b5cfaec76ff011afb" id="r_aa87c1f9c93e7fd1b5cfaec76ff011afb"><td class="memItemLeft" align="right" valign="top"><a id="aa87c1f9c93e7fd1b5cfaec76ff011afb" name="aa87c1f9c93e7fd1b5cfaec76ff011afb"></a>
157+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>BT_RC_CT_TAG</b>&#160;&#160;&#160;&quot;RCCT&quot;</td></tr>
158+
<tr class="separator:aa87c1f9c93e7fd1b5cfaec76ff011afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
86159
<tr class="memitem:ad481f334d9e822be5ddc765a083d51c3" id="r_ad481f334d9e822be5ddc765a083d51c3"><td class="memItemLeft" align="right" valign="top"><a id="ad481f334d9e822be5ddc765a083d51c3" name="ad481f334d9e822be5ddc765a083d51c3"></a>
87-
#define&#160;</td><td class="memItemRight" valign="bottom"><b>IS_VALID_PLATFORM</b>&#160;&#160;&#160;false</td></tr>
160+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>IS_VALID_PLATFORM</b>&#160;&#160;&#160;true</td></tr>
88161
<tr class="separator:ad481f334d9e822be5ddc765a083d51c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
162+
</table><table class="memberdecls">
163+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
164+
Typedefs</h2></td></tr>
165+
<tr class="memitem:a9bee258e477be3c0e70d6029ed86a019" id="r_a9bee258e477be3c0e70d6029ed86a019"><td class="memItemLeft" align="right" valign="top"><a id="a9bee258e477be3c0e70d6029ed86a019" name="a9bee258e477be3c0e70d6029ed86a019"></a>
166+
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><b>app_callback_t</b>) (uint16_t event, void *param)</td></tr>
167+
<tr class="memdesc:a9bee258e477be3c0e70d6029ed86a019"><td class="mdescLeft">&#160;</td><td class="mdescRight">handler for the dispatched work <br /></td></tr>
168+
<tr class="separator:a9bee258e477be3c0e70d6029ed86a019"><td class="memSeparator" colspan="2">&#160;</td></tr>
169+
</table><table class="memberdecls">
170+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
171+
Enumerations</h2></td></tr>
172+
<tr class="memitem:ga28a6ac1cbaf47c9d341da5391e2e72b3" id="r_ga28a6ac1cbaf47c9d341da5391e2e72b3"><td class="memItemLeft" align="right" valign="top"><a id="ga28a6ac1cbaf47c9d341da5391e2e72b3" name="ga28a6ac1cbaf47c9d341da5391e2e72b3"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__a2dp.html#ga28a6ac1cbaf47c9d341da5391e2e72b3">ReconnectStatus</a> { <b>NoReconnect</b>
173+
, <b>AutoReconnect</b>
174+
, <b>IsReconnecting</b>
175+
}</td></tr>
176+
<tr class="memdesc:ga28a6ac1cbaf47c9d341da5391e2e72b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buetooth A2DP Reconnect Status. <br /></td></tr>
177+
<tr class="separator:ga28a6ac1cbaf47c9d341da5391e2e72b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
178+
</table><table class="memberdecls">
179+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
180+
Functions</h2></td></tr>
181+
<tr class="memitem:a4321b5374a1413fafafaec82f896eb1c" id="r_a4321b5374a1413fafafaec82f896eb1c"><td class="memItemLeft" align="right" valign="top"><a id="a4321b5374a1413fafafaec82f896eb1c" name="a4321b5374a1413fafafaec82f896eb1c"></a>
182+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_app_a2d_callback</b> (esp_a2d_cb_event_t event, esp_a2d_cb_param_t *param)</td></tr>
183+
<tr class="separator:a4321b5374a1413fafafaec82f896eb1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
184+
<tr class="memitem:ad11e4bda6ef98605d8df00e510e2703f" id="r_ad11e4bda6ef98605d8df00e510e2703f"><td class="memItemLeft" align="right" valign="top"><a id="ad11e4bda6ef98605d8df00e510e2703f" name="ad11e4bda6ef98605d8df00e510e2703f"></a>
185+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_app_gap_callback</b> (esp_bt_gap_cb_event_t event, esp_bt_gap_cb_param_t *param)</td></tr>
186+
<tr class="separator:ad11e4bda6ef98605d8df00e510e2703f"><td class="memSeparator" colspan="2">&#160;</td></tr>
187+
<tr class="memitem:a88292248eabbb77aee7c6d390bd23f62" id="r_a88292248eabbb77aee7c6d390bd23f62"><td class="memItemLeft" align="right" valign="top"><a id="a88292248eabbb77aee7c6d390bd23f62" name="a88292248eabbb77aee7c6d390bd23f62"></a>
188+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_app_rc_ct_callback</b> (esp_avrc_ct_cb_event_t event, esp_avrc_ct_cb_param_t *param)</td></tr>
189+
<tr class="separator:a88292248eabbb77aee7c6d390bd23f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
190+
<tr class="memitem:ac82ed712dca89857181a7d1835cced7c" id="r_ac82ed712dca89857181a7d1835cced7c"><td class="memItemLeft" align="right" valign="top"><a id="ac82ed712dca89857181a7d1835cced7c" name="ac82ed712dca89857181a7d1835cced7c"></a>
191+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_app_rc_tg_callback</b> (esp_avrc_tg_cb_event_t event, esp_avrc_tg_cb_param_t *param)</td></tr>
192+
<tr class="separator:ac82ed712dca89857181a7d1835cced7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
193+
<tr class="memitem:a0260114b8032359247b14f8e7f613af6" id="r_a0260114b8032359247b14f8e7f613af6"><td class="memItemLeft" align="right" valign="top"><a id="a0260114b8032359247b14f8e7f613af6" name="a0260114b8032359247b14f8e7f613af6"></a>
194+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_av_hdl_avrc_tg_evt</b> (uint16_t event, void *p_param)</td></tr>
195+
<tr class="separator:a0260114b8032359247b14f8e7f613af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
196+
<tr class="memitem:a38e69e5d70cecace49c90db414b97970" id="r_a38e69e5d70cecace49c90db414b97970"><td class="memItemLeft" align="right" valign="top"><a id="a38e69e5d70cecace49c90db414b97970" name="a38e69e5d70cecace49c90db414b97970"></a>
197+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_av_hdl_stack_evt</b> (uint16_t event, void *p_param)</td></tr>
198+
<tr class="separator:a38e69e5d70cecace49c90db414b97970"><td class="memSeparator" colspan="2">&#160;</td></tr>
199+
<tr class="memitem:a6c7e4fb41d19a7d79bce115bd1502649" id="r_a6c7e4fb41d19a7d79bce115bd1502649"><td class="memItemLeft" align="right" valign="top"><a id="a6c7e4fb41d19a7d79bce115bd1502649" name="a6c7e4fb41d19a7d79bce115bd1502649"></a>
200+
void&#160;</td><td class="memItemRight" valign="bottom"><b>ccall_bt_app_task_handler</b> (void *arg)</td></tr>
201+
<tr class="separator:a6c7e4fb41d19a7d79bce115bd1502649"><td class="memSeparator" colspan="2">&#160;</td></tr>
202+
</table><table class="memberdecls">
203+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
204+
Variables</h2></td></tr>
205+
<tr class="memitem:a8a26ad8fa8bfa4ffb3d5f6ecf9d41419" id="r_a8a26ad8fa8bfa4ffb3d5f6ecf9d41419"><td class="memItemLeft" align="right" valign="top"><a id="a8a26ad8fa8bfa4ffb3d5f6ecf9d41419" name="a8a26ad8fa8bfa4ffb3d5f6ecf9d41419"></a>
206+
<a class="el" href="class_bluetooth_a2_d_p_common.html">BluetoothA2DPCommon</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>actual_bluetooth_a2dp_common</b></td></tr>
207+
<tr class="separator:a8a26ad8fa8bfa4ffb3d5f6ecf9d41419"><td class="memSeparator" colspan="2">&#160;</td></tr>
89208
</table>
90209
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
91210
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>

0 commit comments

Comments
 (0)