Skip to content

Commit

Permalink
Deploying to doxygen from @ 292614c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Nov 28, 2024
1 parent 9eba9d4 commit cdb0e6a
Show file tree
Hide file tree
Showing 15 changed files with 744 additions and 739 deletions.
2 changes: 1 addition & 1 deletion _analog_driver_e_s_p32_v1_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>&#160;<span class="preprocessor">#ifdef ARDUINO</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>&#160; <span class="comment">// dummy detach: w/o this it&#39;s failing</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> adcDetachBus(<span class="keywordtype">void</span> *bus) {</div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160; LOGD(<span class="stringliteral">&quot;===&gt; adcDetachBus: %d&quot;</span>, bus);</div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160; LOGD(<span class="stringliteral">&quot;===&gt; adcDetachBus: %d&quot;</span>, (<span class="keywordtype">int</span>) bus);</div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>&#160; }</div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160;<span class="preprocessor">#endif</span></div>
Expand Down
470 changes: 236 additions & 234 deletions _audio_actions_8h_source.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions _audio_board_stream_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,9 @@
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="ttc" id="a_no_arduino_8h_html_ae1e3d979645a535a8ce49f935392d8bc"><div class="ttname"><a href="_no_arduino_8h.html#ae1e3d979645a535a8ce49f935392d8bc">digitalRead</a></div><div class="ttdeci">int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition:</b> NoArduino.h:206</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:29</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:178</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:131</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_affbac7bc51ab35e99434a64b417f73ba"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#affbac7bc51ab35e99434a64b417f73ba">audio_tools::AudioActions::setPinMode</a></div><div class="ttdeci">void setPinMode(bool active)</div><div class="ttdoc">setup pin mode when true</div><div class="ttdef"><b>Definition:</b> AudioActions.h:226</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:180</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:133</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_affbac7bc51ab35e99434a64b417f73ba"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#affbac7bc51ab35e99434a64b417f73ba">audio_tools::AudioActions::setPinMode</a></div><div class="ttdeci">void setPinMode(bool active)</div><div class="ttdoc">setup pin mode when true</div><div class="ttdef"><b>Definition:</b> AudioActions.h:228</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_board_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_board_stream.html">audio_tools::AudioBoardStream</a></div><div class="ttdoc">New functionality which replaces the AudioKitStream that is based on the legacy AudioKit library....</div><div class="ttdef"><b>Definition:</b> AudioBoardStream.h:19</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_board_stream_html_a045696077b56acd7a3a8cefef6659832"><div class="ttname"><a href="classaudio__tools_1_1_audio_board_stream.html#a045696077b56acd7a3a8cefef6659832">audio_tools::AudioBoardStream::addAction</a></div><div class="ttdeci">void addAction(AudioDriverKey key, void(*actionOn)(bool, int, void *), void(*actionOff)(bool, int, void *), void *ref=nullptr)</div><div class="ttdoc">Defines a new action that is executed when the Button is pressed and released.</div><div class="ttdef"><b>Definition:</b> AudioBoardStream.h:73</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_board_stream_html_a059d0367a1404dcf42f06cc59d73f2ce"><div class="ttname"><a href="classaudio__tools_1_1_audio_board_stream.html#a059d0367a1404dcf42f06cc59d73f2ce">audio_tools::AudioBoardStream::pinInputRec</a></div><div class="ttdeci">GpioPin pinInputRec()</div><div class="ttdoc">Get the record-button id for adc-button.</div><div class="ttdef"><b>Definition:</b> AudioBoardStream.h:247</div></div>
Expand Down
4 changes: 2 additions & 2 deletions _audio_kit_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -525,8 +525,8 @@
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="ttc" id="a_audio_tools_8h_html"><div class="ttname"><a href="_audio_tools_8h.html">AudioTools.h</a></div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:29</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:178</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:131</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:180</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:133</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html">audio_tools::AudioKitStreamConfig</a></div><div class="ttdoc">Configuration for AudioKitStream: we use as subclass of I2SConfig.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:23</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html_a4004138f5ff66c31ad339182f71849cd"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html#a4004138f5ff66c31ad339182f71849cd">audio_tools::AudioKitStreamConfig::toAudioKitConfig</a></div><div class="ttdeci">AudioKitConfig toAudioKitConfig()</div><div class="ttdoc">convert to config object needed by HAL</div><div class="ttdef"><b>Definition:</b> AudioKit.h:39</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html_a567e2afb71a4d538ed517075a55b0802"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html#a567e2afb71a4d538ed517075a55b0802">audio_tools::AudioKitStreamConfig::setupI2SPins</a></div><div class="ttdeci">void setupI2SPins(RxTxMode rxtx_mode)</div><div class="ttdoc">Defines the pins based on the information provided by the AudioKit project.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:74</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _codec_helix_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_decoder_helix_html_afef1e91be11d5791ae90f522b46db3d7"><div class="ttname"><a href="classaudio__tools_1_1_decoder_helix.html#afef1e91be11d5791ae90f522b46db3d7">audio_tools::DecoderHelix::resetDecoder</a></div><div class="ttdeci">void resetDecoder()</div><div class="ttdoc">Deletes the decoder.</div><div class="ttdef"><b>Definition:</b> CodecHelix.h:101</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_m_p3_decoder_helix_html"><div class="ttname"><a href="classaudio__tools_1_1_m_p3_decoder_helix.html">audio_tools::MP3DecoderHelix</a></div><div class="ttdoc">MP3 Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix This is basically just a ...</div><div class="ttdef"><b>Definition:</b> CodecMP3Helix.h:17</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_print_html"><div class="ttname"><a href="classaudio__tools_1_1_print.html">audio_tools::Print</a></div><div class="ttdef"><b>Definition:</b> NoArduino.h:58</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_decoder.html">audio_tools::WAVDecoder</a></div><div class="ttdoc">A simple WAVDecoder: We parse the header data on the first record to determine the format....</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:265</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_decoder.html">audio_tools::WAVDecoder</a></div><div class="ttdoc">A simple WAVDecoder: We parse the header data on the first record to determine the format....</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:266</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> AudioConfig.h:823</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:52</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
Loading

0 comments on commit cdb0e6a

Please sign in to comment.