Add comments for external header files

trailhead · Sep 6, 2023 · f377760 · f377760
1 parent 4cee15b
commit f377760
Show file tree

Hide file tree

Showing 81 changed files with 204 additions and 204 deletions.
diff --git a/Audio.h b/Audio.h
@@ -34,7 +34,7 @@
 #error "The Audio Library only works with 32 bit Teensy models.  Teensy 2.0 is unsupported."
 #endif
 
-#include "DMAChannel.h"
+#include <DMAChannel.h>  // github.com/PaulStoffregen/cores/blob/master/teensy4/DMAChannel.h
 #if !defined(DMACHANNEL_HAS_BEGIN) || !defined(DMACHANNEL_HAS_BOOLEAN_CTOR)
 #error "You need to update DMAChannel.h & DMAChannel.cpp"
 #error "https://github.com/PaulStoffregen/cores/blob/master/teensy3/DMAChannel.h"

diff --git a/Quantizer.h b/Quantizer.h
@@ -29,7 +29,7 @@
 #ifndef quantizer_h_
 #define quantizer_h_
 
-#include "Arduino.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
 
 //#define DEBUG_QUANTIZER
 
@@ -61,4 +61,4 @@ float _factor;
 
 };
 
-#endif
+#endif
diff --git a/Resampler.h b/Resampler.h
@@ -31,7 +31,7 @@
 #define resampler_h_
 
 
-#include "Arduino.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
 //#define DEBUG_RESAMPLER  //activates debug output
 
 #define MAX_FILTER_SAMPLES 40961 //=1024*20 +1
@@ -227,4 +227,4 @@ class Resampler {
 		float _targetAttenuation=100;
 };
 
-#endif
+#endif
diff --git a/analyze_fft1024.h b/analyze_fft1024.h
@@ -27,9 +27,9 @@
 #ifndef analyze_fft1024_h_
 #define analyze_fft1024_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
-#include "arm_math.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 // windows.c
 extern "C" {

diff --git a/analyze_fft256.h b/analyze_fft256.h
@@ -27,9 +27,9 @@
 #ifndef analyze_fft256_h_
 #define analyze_fft256_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
-#include "arm_math.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 // windows.c
 extern "C" {

diff --git a/analyze_notefreq.h b/analyze_notefreq.h
@@ -23,8 +23,8 @@
 #ifndef AudioAnalyzeNoteFrequency_h_
 #define AudioAnalyzeNoteFrequency_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 /***********************************************************************
  *              Safe to adjust these values below                      *
  *                                                                     *

diff --git a/analyze_peak.h b/analyze_peak.h
@@ -27,8 +27,8 @@
 #ifndef analyze_peakdetect_h_
 #define analyze_peakdetect_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioAnalyzePeak : public AudioStream
 {

diff --git a/analyze_print.h b/analyze_print.h
@@ -27,8 +27,8 @@
 #ifndef analyze_print_h_
 #define analyze_print_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioAnalyzePrint : public AudioStream
 {

diff --git a/analyze_rms.h b/analyze_rms.h
@@ -27,8 +27,8 @@
 #ifndef analyze_rms_h_
 #define analyze_rms_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioAnalyzeRMS : public AudioStream
 {

diff --git a/analyze_tonedetect.h b/analyze_tonedetect.h
@@ -27,8 +27,8 @@
 #ifndef analyze_tonedetect_h_
 #define analyze_tonedetect_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioAnalyzeToneDetect : public AudioStream
 {

diff --git a/async_input_spdif3.h b/async_input_spdif3.h
@@ -30,10 +30,10 @@
 #define async_input_spdif3_h_
 #include "Resampler.h"
 #include "Quantizer.h"
-#include "Arduino.h"
-#include "AudioStream.h"
-#include "DMAChannel.h"
-#include <arm_math.h>
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
+#include <DMAChannel.h>  // github.com/PaulStoffregen/cores/blob/master/teensy4/DMAChannel.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 //#define DEBUG_SPDIF_IN	//activates debug output
 
@@ -85,4 +85,4 @@ class AsyncAudioInputSPDIF3 : public AudioStream
 #endif
 };
 
-#endif
+#endif
diff --git a/biquad.h b/biquad.h
@@ -29,8 +29,8 @@
 #ifndef biquad_coeffs_h_
 #define biquad_coeffs_h_
 
-#include "Arduino.h"
-#include <arm_math.h>
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 enum class BiquadType {
 	LOW_PASS, HIGH_PASS, BAND_PASS, NOTCH, ALL_PASS, PEAKING, LOW_SHELF, HIGH_SHELF
@@ -201,4 +201,4 @@ void getCoefficients(T* coeffs, BiquadType type, double dbGain, double freq, dou
 		*(S->pState) = (*(S->pCoeffs+1)  + *(S->pCoeffs+3)) * val + *(S->pState+1);
 	}
 
-#endif
+#endif
diff --git a/control_sgtl5000.h b/control_sgtl5000.h
@@ -27,7 +27,7 @@
 #ifndef control_sgtl5000_h_
 #define control_sgtl5000_h_
 
-#include <AudioStream.h>
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 #include "AudioControl.h"
 
 // SGTL5000-specific defines for headphones

diff --git a/control_tlv320aic3206.h b/control_tlv320aic3206.h
@@ -54,8 +54,8 @@
 #ifndef control_tlv320aic3206_h_
 #define control_tlv320aic3206_h_
 
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
 #include "AudioControl.h"
-#include <Arduino.h>
 
 //convenience names to use with inputSelect() to set whnch analog inputs to use
 #define AIC3206_INPUT_IN1            1   //uses IN1

diff --git a/effect_bitcrusher.h b/effect_bitcrusher.h
@@ -28,8 +28,8 @@
 #ifndef effect_bitcrusher_h_
 #define effect_bitcrusher_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectBitcrusher : public AudioStream
 {

diff --git a/effect_chorus.h b/effect_chorus.h
@@ -23,8 +23,8 @@
 #ifndef effect_chorus_h_
 #define effect_chorus_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 /******************************************************************/
 

diff --git a/effect_combine.h b/effect_combine.h
@@ -30,8 +30,8 @@
 
 #ifndef effect_digital_combine_h_
 #define effect_digital_combine_h_
-#include <Arduino.h>
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectDigitalCombine : public AudioStream
 {

diff --git a/effect_delay.h b/effect_delay.h
@@ -26,8 +26,8 @@
 
 #ifndef effect_delay_h_
 #define effect_delay_h_
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 #include "utility/dspinst.h"
 
 #if defined(__IMXRT1062__)

diff --git a/effect_delay_ext.h b/effect_delay_ext.h
@@ -26,8 +26,8 @@
 
 #ifndef effect_delay_ext_h_
 #define effect_delay_ext_h_
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 #include "spi_interrupt.h"
 
 enum AudioEffectDelayMemoryType_t {

diff --git a/effect_envelope.h b/effect_envelope.h
@@ -26,8 +26,8 @@
 
 #ifndef effect_envelope_h_
 #define effect_envelope_h_
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 #include "utility/dspinst.h"
 
 #define SAMPLES_PER_MSEC (AUDIO_SAMPLE_RATE_EXACT/1000.0f)

diff --git a/effect_fade.h b/effect_fade.h
@@ -27,8 +27,8 @@
 #ifndef effect_fade_h_
 #define effect_fade_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectFade : public AudioStream
 {

diff --git a/effect_flange.h b/effect_flange.h
@@ -23,8 +23,8 @@
 #ifndef effect_flange_h_
 #define effect_flange_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 /******************************************************************/
 //                A u d i o E f f e c t F l a n g e

diff --git a/effect_freeverb.h b/effect_freeverb.h
@@ -26,8 +26,8 @@
 
 #ifndef effect_freeverb_h_
 #define effect_freeverb_h_
-#include <Arduino.h>
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectFreeverb : public AudioStream
 {

diff --git a/effect_granular.h b/effect_granular.h
@@ -21,7 +21,7 @@
  * SOFTWARE.
  */
 
-#include "AudioStream.h"
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectGranular : public AudioStream
 {

diff --git a/effect_midside.h b/effect_midside.h
@@ -23,8 +23,8 @@
 #ifndef effect_midside_decode_h_
 #define effect_midside_decode_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 #include "utility/dspinst.h"
 

diff --git a/effect_multiply.h b/effect_multiply.h
@@ -26,8 +26,8 @@
 
 #ifndef effect_multiply_h_
 #define effect_multiply_h_
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 #include "utility/dspinst.h"
 
 class AudioEffectMultiply : public AudioStream

diff --git a/effect_rectifier.h b/effect_rectifier.h
@@ -27,8 +27,8 @@
 #ifndef effect_rectifier_h_
 #define effect_rectifier_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectRectifier: public AudioStream
 {

diff --git a/effect_reverb.h b/effect_reverb.h
@@ -29,7 +29,7 @@
 #ifndef effect_reverb_
 #define effect_reverb_
 
-#include "AudioStream.h"
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 #define APF1_BUF_LEN 600
 #define APF2_BUF_LEN 1300

diff --git a/effect_wavefolder.h b/effect_wavefolder.h
@@ -24,8 +24,8 @@
 #ifndef effect_wavefolder_h_
 #define effect_wavefolder_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectWaveFolder : public AudioStream
 {

diff --git a/effect_waveshaper.h b/effect_waveshaper.h
@@ -25,8 +25,8 @@
 #ifndef effect_waveshaper_h_
 #define effect_waveshaper_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioEffectWaveshaper : public AudioStream
 {

diff --git a/filter_biquad.h b/filter_biquad.h
@@ -27,8 +27,8 @@
 #ifndef filter_biquad_h_
 #define filter_biquad_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
 
 class AudioFilterBiquad : public AudioStream
 {

diff --git a/filter_fir.h b/filter_fir.h
@@ -23,9 +23,9 @@
 #ifndef filter_fir_h_
 #define filter_fir_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
-#include "arm_math.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 // Indicates that the code should just pass through the audio
 // without any filtering (as opposed to doing nothing at all)

diff --git a/filter_ladder.h b/filter_ladder.h
@@ -38,9 +38,9 @@
 #ifndef filter_ladder_h_
 #define filter_ladder_h_
 
-#include "Arduino.h"
-#include "AudioStream.h"
-#include "arm_math.h"
+#include <Arduino.h>     // github.com/PaulStoffregen/cores/blob/master/teensy4/Arduino.h
+#include <AudioStream.h> // github.com/PaulStoffregen/cores/blob/master/teensy4/AudioStream.h
+#include <arm_math.h>    // github.com/PaulStoffregen/cores/blob/master/teensy4/arm_math.h
 
 enum AudioFilterLadderInterpolation {
 	LADDER_FILTER_INTERPOLATION_LINEAR,