Documentation

Author: pschatzmann

src/AudioEffects/AudioEffectsSuite.h

@@ -27,15 +27,19 @@ namespace audio_tools {
 typedef float effectsuite_t;
 
 /**
- * Table of interpolation values as a 2D array indexed by
+ * @brief Table of interpolation values as a 2D array indexed by
  * interpolationTable[pointIndex][alphaIndex]
  */
 static effectsuite_t **interpolationTable = nullptr;
 
+/**
+ * @brief Base Class for Effects
+ * 
+ */
 
 class EffectSuiteBase  : public AudioEffect {
-    /**
-   * Main process block for applying audio effect
+  /**
+   * @brief Main process block for applying audio effect
    * @param inputSample The input audio sample for the effect to be applied to
    * @returns an audio sample as a effectsuite_t with effect applied
    */
@@ -54,7 +58,7 @@ class EffectSuiteBase  : public AudioEffect {
 
 
 /**
- * Class provides a wave table that can be populated with a number of
+ * @brief Class provides a wave table that can be populated with a number of
  * preallocated waveforms. These can be used to generate audio in themselves or
  * to modulate The parameters of another effect. Class initialised with sample
  * rate.
@@ -79,7 +83,7 @@ class ModulationBaseClass {
   ~ModulationBaseClass() = default;
 
   /**
-   * setup the class with a given sample rate. Basically reperforming the
+   * @brief setup the class with a given sample rate. Basically reperforming the
    * constructor
    * @param extSampRate External sample rate
    */
@@ -343,7 +347,7 @@ class ModulationBaseClass {
 };
 
 /**
- * A Base class for delay based digital effects. Provides the basic methods
+ * @brief A Base class for delay based digital effects. Provides the basic methods
  * that are shared amongst Flanger, Delay, Chorus and Phaser
  * @version 0.1
  * @see DelayEffectBase
@@ -578,7 +582,7 @@ class DelayEffectBase  {
 };
 
 /**
- * A Base class for filter based effects including methods for simple
+ * @brief A Base class for filter based effects including methods for simple
  * high, low and band pass filtering
  * @see FilterEffectBase
  * @author Matthew Hamilton
@@ -977,7 +981,7 @@ class SimpleLPF : public FilterEffectBase {
 };
 
 /**
- * Simple Chorus effect with a single delay voice and mono output Chorus is
+ * @brief Simple Chorus effect with a single delay voice and mono output Chorus is
  * effective between 15 and 20 miliseconds delay of original audio. Requires the
  * sample rate when initialising.
  * @author Matthew Hamilton
@@ -1113,7 +1117,7 @@ class SimpleChorus : public DelayEffectBase,
 };
 
 /**
- * Delay effect that filters the repeat delay 
+ * @brief Delay effect that filters the repeat delay 
  * @author Matthew Hamilton
  * @copyright MIT License
  */
@@ -1185,7 +1189,7 @@ class FilteredDelay : public DelayEffectBase, public FilterEffectBase {
 };
 
 /**
- * Simple Delay effect consiting of a single tap delay with Effect Gain and
+ * @brief Simple Delay effect consiting of a single tap delay with Effect Gain and
  * feed back controls
  * Constructor requires internal delay in samples
  * @see process
@@ -1357,7 +1361,7 @@ class SimpleDelay : public DelayEffectBase, public EffectSuiteBase {
 };
 
 /**
- * Simple Flanger Effect Consistig of a single voice flanger
+ * @brief Simple Flanger Effect Consistig of a single voice flanger
  * The flanger has an effective range between 0 and 15 miliseconds
  * in this case dleay buffer should be set to sampleRate*3/200
  * Constructor requires internal delay in samples

src/AudioEffects/STKEffects.h

@@ -17,7 +17,7 @@
 namespace audio_tools {
 
 /**
- * Use any effect from the STK framework: e.g. Chorus, Echo, FreeVerb, JCRev,
+ * @brief Use any effect from the STK framework: e.g. Chorus, Echo, FreeVerb, JCRev,
  * PitShift... https://github.com/pschatzmann/Arduino-STK
  *
  * @author Phil Schatzmann
@@ -38,7 +38,7 @@ class STKEffect : public AudioEffect {
 };
 
 /**
- * Chorus Effect
+ * @brief Chorus Effect
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -54,7 +54,7 @@ class STKChorus : public AudioEffect, public stk::Chorus {
 };
 
 /**
- * Echo Effect
+ * @brief Echo Effect
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -71,7 +71,7 @@ class STKEcho : public AudioEffect, public stk::Echo {
 };
 
 /**
- * Jezar at Dreampoint's FreeVerb, implemented in STK.
+ * @brief Jezar at Dreampoint's FreeVerb, implemented in STK.
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -86,7 +86,7 @@ class STKFreeVerb : public AudioEffect, public stk::FreeVerb {
 };
 
 /**
- * John Chowning's reverberator class.
+ * @brief John Chowning's reverberator class.
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -102,7 +102,7 @@ class STKChowningReverb : public AudioEffect, public stk::JCRev {
 };
 
 /**
- * CCRMA's NRev reverberator class.
+ * @brief CCRMA's NRev reverberator class.
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -117,7 +117,7 @@ class STKNReverb : public AudioEffect, public stk::NRev {
 };
 
 /**
- * Perry's simple reverberator class
+ * @brief Perry's simple reverberator class
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -132,7 +132,7 @@ class STKPerryReverb : public AudioEffect, public stk::PRCRev {
 };
 
 /**
- * Pitch shifter effect class based on the Lent algorithm
+ * @brief Pitch shifter effect class based on the Lent algorithm
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -149,7 +149,7 @@ class STKLentPitShift : public AudioEffect, public stk::LentPitShift {
 };
 
 /**
- * Pitch shifter effect class based on the Lent algorithm
+ * @brief Pitch shifter effect class based on the Lent algorithm
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioLibs/AudioA2DP.h

@@ -57,7 +57,11 @@ void a2dp_stream_sink_sound_data(const uint8_t* data, uint32_t len);
 enum A2DPStartLogic {StartWhenBufferFull, StartOnConnect};
 enum A2DPNoData {A2DPSilence, A2DPWhoosh};
 
-// Config for A2DP Stream
+/**
+ * @brief Configuration for A2DPStream
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
 class A2DPConfig {
     public:
         A2DPStartLogic startLogic = StartWhenBufferFull;
@@ -73,6 +77,8 @@ class A2DPConfig {
  * The data is in int16_t with 2 channels at 44100 hertz. 
  *
  * Because we support only one instance the class is implemented as singleton!
+ * @author Phil Schatzmann
+ * @copyright GPLv3
  */
 class A2DPStream : public AudioStream, public AudioBaseInfoSource {