Docu correction

Author: pschatzmann

docs/html/_snap_client_8h_source.html

@@ -273,7 +273,7 @@
 <div class="ttc" id="aclass_snap_client_html_a25ac7501d9bf855ea1bd07feb77e9070"><div class="ttname"><a href="class_snap_client.html#a25ac7501d9bf855ea1bd07feb77e9070">SnapClient::setServerIP</a></div><div class="ttdeci">void setServerIP(IPAddress ipAddress)</div><div class="ttdoc">Defines the Snapcast Server IP address.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:76</div></div>
 <div class="ttc" id="aclass_snap_client_html_a26a56ec17a4183c08447e33c80591209"><div class="ttname"><a href="class_snap_client.html#a26a56ec17a4183c08447e33c80591209">SnapClient::setStartTask</a></div><div class="ttdeci">void setStartTask(bool flag)</div><div class="ttdoc">For testing to deactivate the starting of the http task.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:134</div></div>
 <div class="ttc" id="aclass_snap_client_html_a33755d7beaca179dfbdb2c7ef7e1943f"><div class="ttname"><a href="class_snap_client.html#a33755d7beaca179dfbdb2c7ef7e1943f">SnapClient::~SnapClient</a></div><div class="ttdeci">~SnapClient()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:67</div></div>
-<div class="ttc" id="aclass_snap_client_html_a4ee9280c3692bb64624dbc933acae273"><div class="ttname"><a href="class_snap_client.html#a4ee9280c3692bb64624dbc933acae273">SnapClient::doLoop</a></div><div class="ttdeci">void doLoop()</div><div class="ttdoc">Call from Arduino Loop (when no tasks are used)</div><div class="ttdef"><b>Definition:</b> SnapClient.h:150</div></div>
+<div class="ttc" id="aclass_snap_client_html_a4ee9280c3692bb64624dbc933acae273"><div class="ttname"><a href="class_snap_client.html#a4ee9280c3692bb64624dbc933acae273">SnapClient::doLoop</a></div><div class="ttdeci">void doLoop()</div><div class="ttdoc">Call from Arduino Loop - to receive and process the audio data.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:150</div></div>
 <div class="ttc" id="aclass_snap_client_html_a5d9c21ad999d25919c01753e38a86bda"><div class="ttname"><a href="class_snap_client.html#a5d9c21ad999d25919c01753e38a86bda">SnapClient::setSnapOutput</a></div><div class="ttdeci">void setSnapOutput(SnapOutput &amp;out)</div><div class="ttdoc">Defines the Snap output implementation to be used.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:145</div></div>
 <div class="ttc" id="aclass_snap_client_html_a601fb7cf1fc15db50c71a826f084f934"><div class="ttname"><a href="class_snap_client.html#a601fb7cf1fc15db50c71a826f084f934">SnapClient::begin</a></div><div class="ttdeci">bool begin()</div><div class="ttdoc">Starts the processing.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:90</div></div>
 <div class="ttc" id="aclass_snap_client_html_a7ffb49aa46d01ea1f30e374e0573cc83"><div class="ttname"><a href="class_snap_client.html#a7ffb49aa46d01ea1f30e374e0573cc83">SnapClient::setVolumeFactor</a></div><div class="ttdeci">void setVolumeFactor(float fact)</div><div class="ttdoc">Adjust volume by factor e.g. 1.5.</div><div class="ttdef"><b>Definition:</b> SnapClient.h:131</div></div>
@@ -286,13 +286,13 @@
 <div class="ttc" id="aclass_snap_output_html"><div class="ttname"><a href="class_snap_output.html">SnapOutput</a></div><div class="ttdoc">Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...</div><div class="ttdef"><b>Definition:</b> SnapOutput.h:26</div></div>
 <div class="ttc" id="aclass_snap_output_html_ad703cdbab7c0a7f312178595a1fb2f58"><div class="ttname"><a href="class_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58">SnapOutput::setSnapTimeSync</a></div><div class="ttdeci">void setSnapTimeSync(SnapTimeSync &amp;timeSync)</div><div class="ttdoc">Defines the time synchronization logic.</div><div class="ttdef"><b>Definition:</b> SnapOutput.h:120</div></div>
 <div class="ttc" id="aclass_snap_processor_html"><div class="ttname"><a href="class_snap_processor.html">SnapProcessor</a></div><div class="ttdoc">Snap Processor implementation which does not rely on FreeRTOS.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:19</div></div>
-<div class="ttc" id="aclass_snap_processor_html_a5d9c21ad999d25919c01753e38a86bda"><div class="ttname"><a href="class_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda">SnapProcessor::setSnapOutput</a></div><div class="ttdeci">void setSnapOutput(SnapOutput &amp;out)</div><div class="ttdoc">Defines the SnapOutput implementation.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:83</div></div>
-<div class="ttc" id="aclass_snap_processor_html_a6f9488e045147706a13387c0c6a634ea"><div class="ttname"><a href="class_snap_processor.html#a6f9488e045147706a13387c0c6a634ea">SnapProcessor::setDecoder</a></div><div class="ttdeci">void setDecoder(AudioDecoder &amp;dec)</div><div class="ttdoc">Defines the decoder class.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:74</div></div>
-<div class="ttc" id="aclass_snap_processor_html_a7ffb49aa46d01ea1f30e374e0573cc83"><div class="ttname"><a href="class_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83">SnapProcessor::setVolumeFactor</a></div><div class="ttdeci">void setVolumeFactor(float fact)</div><div class="ttdoc">Adjust volume by factor e.g. 1.5.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:80</div></div>
-<div class="ttc" id="aclass_snap_processor_html_a92937495d01c777a843b576f7fd02145"><div class="ttname"><a href="class_snap_processor.html#a92937495d01c777a843b576f7fd02145">SnapProcessor::volume</a></div><div class="ttdeci">float volume(void)</div><div class="ttdoc">Provides the volume (in the range of 0.0 to 1.0)</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:77</div></div>
-<div class="ttc" id="aclass_snap_processor_html_aa0d3775308edf58cac6e7f763edbb96a"><div class="ttname"><a href="class_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a">SnapProcessor::setOutput</a></div><div class="ttdeci">void setOutput(AudioOutput &amp;output)</div><div class="ttdoc">Defines the output class.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:71</div></div>
-<div class="ttc" id="aclass_snap_processor_html_aa4dbb35cfcc65d0c880983d78edd8ac3"><div class="ttname"><a href="class_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3">SnapProcessor::setClient</a></div><div class="ttdeci">void setClient(Client &amp;client)</div><div class="ttdoc">Defines an alternative client to the WiFiClient.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:88</div></div>
-<div class="ttc" id="aclass_snap_processor_html_ae0d28a9842dd1a20e72bdf59f8892fb8"><div class="ttname"><a href="class_snap_processor.html#ae0d28a9842dd1a20e72bdf59f8892fb8">SnapProcessor::doLoop</a></div><div class="ttdeci">virtual void doLoop()</div><div class="ttdoc">Call via SnapClient in Arduino Loop!</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:68</div></div>
+<div class="ttc" id="aclass_snap_processor_html_a5d9c21ad999d25919c01753e38a86bda"><div class="ttname"><a href="class_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda">SnapProcessor::setSnapOutput</a></div><div class="ttdeci">void setSnapOutput(SnapOutput &amp;out)</div><div class="ttdoc">Defines the SnapOutput implementation.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:85</div></div>
+<div class="ttc" id="aclass_snap_processor_html_a6f9488e045147706a13387c0c6a634ea"><div class="ttname"><a href="class_snap_processor.html#a6f9488e045147706a13387c0c6a634ea">SnapProcessor::setDecoder</a></div><div class="ttdeci">void setDecoder(AudioDecoder &amp;dec)</div><div class="ttdoc">Defines the decoder class.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:76</div></div>
+<div class="ttc" id="aclass_snap_processor_html_a7ffb49aa46d01ea1f30e374e0573cc83"><div class="ttname"><a href="class_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83">SnapProcessor::setVolumeFactor</a></div><div class="ttdeci">void setVolumeFactor(float fact)</div><div class="ttdoc">Adjust volume by factor e.g. 1.5.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:82</div></div>
+<div class="ttc" id="aclass_snap_processor_html_a92937495d01c777a843b576f7fd02145"><div class="ttname"><a href="class_snap_processor.html#a92937495d01c777a843b576f7fd02145">SnapProcessor::volume</a></div><div class="ttdeci">float volume(void)</div><div class="ttdoc">Provides the volume (in the range of 0.0 to 1.0)</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:79</div></div>
+<div class="ttc" id="aclass_snap_processor_html_aa0d3775308edf58cac6e7f763edbb96a"><div class="ttname"><a href="class_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a">SnapProcessor::setOutput</a></div><div class="ttdeci">void setOutput(AudioOutput &amp;output)</div><div class="ttdoc">Defines the output class.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:73</div></div>
+<div class="ttc" id="aclass_snap_processor_html_aa4dbb35cfcc65d0c880983d78edd8ac3"><div class="ttname"><a href="class_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3">SnapProcessor::setClient</a></div><div class="ttdeci">void setClient(Client &amp;client)</div><div class="ttdoc">Defines an alternative client to the WiFiClient.</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:90</div></div>
+<div class="ttc" id="aclass_snap_processor_html_ae0d28a9842dd1a20e72bdf59f8892fb8"><div class="ttname"><a href="class_snap_processor.html#ae0d28a9842dd1a20e72bdf59f8892fb8">SnapProcessor::doLoop</a></div><div class="ttdeci">virtual void doLoop()</div><div class="ttdoc">Call via SnapClient in Arduino Loop!</div><div class="ttdef"><b>Definition:</b> SnapProcessor.h:70</div></div>
 <div class="ttc" id="aclass_snap_time_html"><div class="ttname"><a href="class_snap_time.html">SnapTime</a></div><div class="ttdoc">The the sys/time functions are used to represent the server time. The local time will be measured wit...</div><div class="ttdef"><b>Definition:</b> SnapTime.h:16</div></div>
 <div class="ttc" id="aclass_snap_time_sync_html"><div class="ttname"><a href="class_snap_time_sync.html">SnapTimeSync</a></div><div class="ttdoc">Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:15</div></div>
 </div><!-- fragment --></div><!-- contents -->

docs/html/_snap_config_8h_source.html

@@ -89,7 +89,7 @@
 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#  define CONFIG_NVS_FLASH false</span></div>
 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#ifndef CONFIG_CHECK_HEAP </span></div>
-<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#  define CONFIG_CHECK_HEAP true</span></div>
+<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#  define CONFIG_CHECK_HEAP false</span></div>
 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>
 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// snapcast parameters; </span></div>