From 2610a27532bb6bf7530d2a9c22b23c9d450c8227 Mon Sep 17 00:00:00 2001
From: UnknownSuperficialNight
 <88142731+UnknownSuperficialNight@users.noreply.github.com>
Date: Wed, 2 Oct 2024 04:59:57 +1300
Subject: [PATCH] Add documentation to non experimental AutomaticGainControl

---
 src/source/agc.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/source/agc.rs b/src/source/agc.rs
index 7afd414b..a263b4e3 100644
--- a/src/source/agc.rs
+++ b/src/source/agc.rs
@@ -59,6 +59,10 @@ pub struct AutomaticGainControl<I> {
 }
 
 #[cfg(not(feature = "experimental"))]
+/// Automatic Gain Control filter for maintaining consistent output levels.
+///
+/// This struct implements an AGC algorithm that dynamically adjusts audio levels
+/// based on both **peak** and **RMS** (Root Mean Square) measurements.
 #[derive(Clone, Debug)]
 pub struct AutomaticGainControl<I> {
     input: I,