Skip to content

Commit

Permalink
Correct doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcombriat committed Nov 28, 2024
1 parent dc3a7b3 commit 300573e
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion AudioDelayFeedback.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ with the input, do it in your sketch. AudioDelayFeedback uses more processing an
than a plain AudioDelay, but allows for more dramatic effects with feedback.
@tparam INTERP_TYPE a choice of LINEAR (default) or ALLPASS interpolation. LINEAR is better
for sweeping delay times, ALLPASS may be better for reverb-like effects.
@tparam the type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.
@tparam su the type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.
*/
template <uint16_t NUM_BUFFER_SAMPLES, int8_t INTERP_TYPE = LINEAR, typename su=int8_t>
class AudioDelayFeedback
Expand Down
2 changes: 1 addition & 1 deletion extras/doc/html/_audio_delay_feedback_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">than a plain AudioDelay, but allows for more dramatic effects with feedback.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">@tparam INTERP_TYPE a choice of LINEAR (default) or ALLPASS interpolation. LINEAR is better</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">for sweeping delay times, ALLPASS may be better for reverb-like effects.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">@tparam the type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">@tparam su the type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">template</span> &lt;uint16_t NUM_BUFFER_SAMPLES, int8_t INTERP_TYPE = LINEAR, <span class="keyword">typename</span> su=int8_t&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_audio_delay_feedback.html"> 38</a></span>&#160;<span class="keyword">class</span> <a class="code" href="class_audio_delay_feedback.html">AudioDelayFeedback</a></div>
Expand Down
2 changes: 1 addition & 1 deletion extras/doc/html/class_audio_delay_feedback.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
<table class="tparams">
<tr><td class="paramname">NUM_BUFFER_SAMPLES</td><td>is the length of the delay buffer in samples, and should be a power of two. The maximum delay length which will fit in an atmega328 is half that of a plain <a class="el" href="class_audio_delay.html" title="Audio delay line for comb filter, flange, chorus and short echo effects.">AudioDelay</a> object, in this case 256 cells, or about 15 milliseconds. <a class="el" href="class_audio_delay_feedback.html" title="Audio delay line with feedback for comb filter, flange, chorus and short echo effects.">AudioDelayFeedback</a> uses int16_t sized cells to accomodate the higher amplitude of direct input to the delay as well as the feedback, without losing precision. Output is only the delay line signal. If you want to mix the delay with the input, do it in your sketch. <a class="el" href="class_audio_delay_feedback.html" title="Audio delay line with feedback for comb filter, flange, chorus and short echo effects.">AudioDelayFeedback</a> uses more processing and memory than a plain <a class="el" href="class_audio_delay.html" title="Audio delay line for comb filter, flange, chorus and short echo effects.">AudioDelay</a>, but allows for more dramatic effects with feedback. </td></tr>
<tr><td class="paramname">INTERP_TYPE</td><td>a choice of LINEAR (default) or ALLPASS interpolation. LINEAR is better for sweeping delay times, ALLPASS may be better for reverb-like effects. </td></tr>
<tr><td class="paramname">the</td><td>type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2. </td></tr>
<tr><td class="paramname">su</td><td>the type of numbers to use for the signal in the delay. The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2. </td></tr>
</table>
</dd>
</dl>
Expand Down

0 comments on commit 300573e

Please sign in to comment.