AudioPWM comments

pschatzmann · Dec 30, 2024 · d9ba159 · d9ba159
1 parent a4aff1d
commit d9ba159
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/AudioTools/CoreAudio/AudioPWM/AudioPWM.h b/src/AudioTools/CoreAudio/AudioPWM/AudioPWM.h
@@ -13,9 +13,10 @@
 namespace audio_tools {
 
 /**
- * @brief Common functionality for PWM output.
- * Please use the PWMAudioOutput typedef instead which references the
- * implementation
+ * @brief Common functionality for PWM output. We generate audio using PWM
+ * with a frequency that is above the hearing range. The sample rate is 
+ * usually quite restricted, so we also automatically decimate the data.
+ * Further info see PWMConfig
  * @ingroup io
  */
 class PWMAudioOutput : public AudioOutput {