Deploying to doxygen from @ 0003dea 🚀

Author: pschatzmann

_audio_player_protocol_8h_source.html

@@ -86,11 +86,6 @@
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
 <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__tools.html">audio_tools</a> {</div>
 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span> </div>
-<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">/***</span></div>
-<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * @brief  Abstract class for protocol to control the audio player.</span></div>
-<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * @ingroup player</span></div>
-<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * @author Phil Schatzmann</span></div>
-<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> */</span></div>
 <div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_player_protocol.html">   11</a></span><span class="keyword">class </span><a class="code hl_class" href="classaudio__tools_1_1_audio_player_protocol.html">AudioPlayerProtocol</a> {</div>
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> <span class="keyword">public</span>:</div>
@@ -127,7 +122,7 @@
 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>}  <span class="comment">// namespace audio_tools</span></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html">audio_tools::AudioPlayer</a></div><div class="ttdoc">High-level audio playback pipeline and controller.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:51</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html">audio_tools::AudioPlayerProtocol</a></div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:11</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html">audio_tools::AudioPlayerProtocol</a></div><div class="ttdoc">Abstract class for protocol to control the audio player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:11</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a205cb30c12c8ab2cd8eb135f42611399"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a205cb30c12c8ab2cd8eb135f42611399">audio_tools::AudioPlayerProtocol::setMaxInputBufferSize</a></div><div class="ttdeci">void setMaxInputBufferSize(int size)</div><div class="ttdoc">Defines the input buffer size used by the readLine function (default 256)</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:28</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a383fc172ea8b7b09d1ded527047b07de"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a383fc172ea8b7b09d1ded527047b07de">audio_tools::AudioPlayerProtocol::readLine</a></div><div class="ttdeci">int readLine(Stream &amp;in, char *str, int max)</div><div class="ttdoc">Reads a line delimited by ' ' from the stream.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:35</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a71bda82938183043ae813edd2d3a2885"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a71bda82938183043ae813edd2d3a2885">audio_tools::AudioPlayerProtocol::processCommand</a></div><div class="ttdeci">virtual bool processCommand(const char *input, Print &amp;result)=0</div></div>

_audio_player_protocol_server_8h_source.html

@@ -89,11 +89,6 @@
 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaudio__tools.html">audio_tools</a> {</div>
 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
-<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">/***</span></div>
-<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * @brief Audio Player Protocol Server: We can use the indicated protocol over</span></div>
-<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * http to control the audio player provided by the audiotools.</span></div>
-<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * @author Phil Schatzmann</span></div>
-<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> */</span></div>
 <div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_player_protocol_server.html">   14</a></span><span class="keyword">class </span><a class="code hl_class" href="classaudio__tools_1_1_audio_player_protocol_server.html">AudioPlayerProtocolServer</a> {</div>
 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> <span class="keyword">public</span>:</div>
@@ -172,9 +167,9 @@
 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>}  <span class="comment">// namespace audio_tools</span></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html">audio_tools::AudioPlayer</a></div><div class="ttdoc">High-level audio playback pipeline and controller.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:51</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html">audio_tools::AudioPlayerProtocol</a></div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:11</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html">audio_tools::AudioPlayerProtocol</a></div><div class="ttdoc">Abstract class for protocol to control the audio player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:11</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a83d10b9dd3cc7fe7fbe5eaf2c1c3fc3b"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a83d10b9dd3cc7fe7fbe5eaf2c1c3fc3b">audio_tools::AudioPlayerProtocol::setPlayer</a></div><div class="ttdeci">virtual void setPlayer(AudioPlayer &amp;player)</div><div class="ttdoc">Defines the player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:25</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_server_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol_server.html">audio_tools::AudioPlayerProtocolServer</a></div><div class="ttdef"><b>Definition</b> AudioPlayerProtocolServer.h:14</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_server_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol_server.html">audio_tools::AudioPlayerProtocolServer</a></div><div class="ttdoc">Audio Player Protocol Server: We can use the indicated protocol over http to control the audio player...</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocolServer.h:14</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_server_html_a7ed436d02498a9c924f34e69c89bc7d5"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol_server.html#a7ed436d02498a9c924f34e69c89bc7d5">audio_tools::AudioPlayerProtocolServer::AudioPlayerProtocolServer</a></div><div class="ttdeci">AudioPlayerProtocolServer()=default</div><div class="ttdoc">Empty constructor: call setPlayer to define the player.</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_server_html_a9f5c313e5aff9cb6f5dae65be9cdb2e2"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol_server.html#a9f5c313e5aff9cb6f5dae65be9cdb2e2">audio_tools::AudioPlayerProtocolServer::setPlayer</a></div><div class="ttdeci">void setPlayer(AudioPlayer &amp;player)</div><div class="ttdoc">Defines the player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocolServer.h:32</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_server_html_ac303b5613b86d16b322a80accd0bdce4"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol_server.html#ac303b5613b86d16b322a80accd0bdce4">audio_tools::AudioPlayerProtocolServer::AudioPlayerProtocolServer</a></div><div class="ttdeci">AudioPlayerProtocolServer(AudioPlayerProtocol &amp;protocol, AudioPlayer &amp;player, int port=80, const char *ssid=nullptr, const char *pwd=nullptr)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocolServer.h:17</div></div>

_audio_source_v_f_s_8h_source.html

@@ -251,7 +251,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_str_view_html_ad2398aedf2b539a7f37ae4c9130266ae"><div class="ttname"><a href="classaudio__tools_1_1_str_view.html#ad2398aedf2b539a7f37ae4c9130266ae">audio_tools::StrView::endsWithIgnoreCase</a></div><div class="ttdeci">virtual bool endsWithIgnoreCase(const char *str)</div><div class="ttdoc">checks if the string ends with the indicated substring</div><div class="ttdef"><b>Definition</b> StrView.h:185</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_stream.html">audio_tools::Stream</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:142</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_v_f_s_file_html"><div class="ttname"><a href="classaudio__tools_1_1_v_f_s_file.html">audio_tools::VFSFile</a></div><div class="ttdoc">Arduino File support using std::fstream.</div><div class="ttdef"><b>Definition</b> VFSFile.h:33</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_v_f_s_html"><div class="ttname"><a href="classaudio__tools_1_1_v_f_s.html">audio_tools::VFS</a></div><div class="ttdef"><b>Definition</b> VFS.h:15</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_v_f_s_html"><div class="ttname"><a href="classaudio__tools_1_1_v_f_s.html">audio_tools::VFS</a></div><div class="ttdoc">Base class which uses c++ file functions. It is also used as base class for an ESP32 Virtual File Sys...</div><div class="ttdef"><b>Definition</b> VFS.h:15</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_v_f_s_html_a50f45551c10ca30a0bc7f447e70188b1"><div class="ttname"><a href="classaudio__tools_1_1_v_f_s.html#a50f45551c10ca30a0bc7f447e70188b1">audio_tools::VFS::begin</a></div><div class="ttdeci">virtual bool begin()</div><div class="ttdoc">mount the file systems</div><div class="ttdef"><b>Definition</b> VFS.h:18</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_v_f_s_html_adc34417a19a7b70626d19c41072d72a5"><div class="ttname"><a href="classaudio__tools_1_1_v_f_s.html#adc34417a19a7b70626d19c41072d72a5">audio_tools::VFS::end</a></div><div class="ttdeci">virtual void end()</div><div class="ttdoc">unmount the file system</div><div class="ttdef"><b>Definition</b> VFS.h:20</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:10</div></div>