doxygen

docs/html/_bluetooth_a2_d_p_source_8h_source.html

@@ -341,7 +341,7 @@
 <div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_adec130ac9f0a83f5c121ab1e5d2cafba"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#adec130ac9f0a83f5c121ab1e5d2cafba">BluetoothA2DPSource::start_raw</a></div><div class="ttdeci">virtual void start_raw(music_data_cb_t callback=NULL)</div><div class="ttdoc">Starts w/o indicating the name. Connections will be managed via set_ssid_callback()</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.h:146</div></div>
 <div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_ae9f14078c1d5dd00c93049fa8b2e283e"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#ae9f14078c1d5dd00c93049fa8b2e283e">BluetoothA2DPSource::bt_av_hdl_avrc_ct_evt</a></div><div class="ttdeci">virtual void bt_av_hdl_avrc_ct_evt(uint16_t event, void *p_param)</div><div class="ttdoc">avrc CT event handler</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.cpp:947</div></div>
 <div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_aed760968d1114bf993325302deef0fb1"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#aed760968d1114bf993325302deef0fb1">BluetoothA2DPSource::start_raw</a></div><div class="ttdeci">virtual void start_raw(const char *name, music_data_cb_t callback=NULL)</div><div class="ttdoc">starts the bluetooth source</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.cpp:164</div></div>
-<div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_af29d19e53e3585446fc294a3213a06af"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#af29d19e53e3585446fc294a3213a06af">BluetoothA2DPSource::is_discovery_active</a></div><div class="ttdeci">virtual bool is_discovery_active()</div><div class="ttdoc">Provides the current discovery state.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.h:194</div></div>
+<div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_af29d19e53e3585446fc294a3213a06af"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#af29d19e53e3585446fc294a3213a06af">BluetoothA2DPSource::is_discovery_active</a></div><div class="ttdeci">virtual bool is_discovery_active()</div><div class="ttdoc">Provides the current discovery state: returns true when the discovery is in progress.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.h:194</div></div>
 <div class="ttc" id="aclass_sound_data_html"><div class="ttname"><a href="class_sound_data.html">SoundData</a></div><div class="ttdoc">Sound data as byte stream. We support TwoChannelSoundData (uint16_t + uint16_t) and OneChannelSoundDa...</div><div class="ttdef"><b>Definition:</b> SoundData.h:71</div></div>
 <div class="ttc" id="astructbt__app__msg__t_html"><div class="ttname"><a href="structbt__app__msg__t.html">bt_app_msg_t</a></div><div class="ttdoc">Internal message to be sent for BluetoothA2DPSink and BluetoothA2DPSource.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:107</div></div>
 </div><!-- fragment --></div><!-- contents -->

docs/html/class_bluetooth_a2_d_p_source.html

@@ -158,7 +158,7 @@
 <tr class="separator:a5e76412770515732e3f54275decf02f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af29d19e53e3585446fc294a3213a06af"><td class="memItemLeft" align="right" valign="top"><a id="af29d19e53e3585446fc294a3213a06af"></a>
 virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_a2_d_p_source.html#af29d19e53e3585446fc294a3213a06af">is_discovery_active</a> ()</td></tr>
-<tr class="memdesc:af29d19e53e3585446fc294a3213a06af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the current discovery state. <br /></td></tr>
+<tr class="memdesc:af29d19e53e3585446fc294a3213a06af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the current discovery state: returns true when the discovery is in progress. <br /></td></tr>
 <tr class="separator:af29d19e53e3585446fc294a3213a06af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a791432e5c800e75fb11b858071cff651"><td class="memItemLeft" align="right" valign="top"><a id="a791432e5c800e75fb11b858071cff651"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_a2_d_p_common.html#a791432e5c800e75fb11b858071cff651">log_free_heap</a> ()</td></tr>

src/BluetoothA2DPSource.h

@@ -190,7 +190,7 @@ class BluetoothA2DPSource : public BluetoothA2DPCommon {
       discovery_mode_callback = callback;
     }
 
-    /// Provides the current discovery state
+    /// Provides the current discovery state: returns true when the discovery is in progress
     virtual bool is_discovery_active() {
       return discovery_active;
     }