From 1be2f8c535ee88d33f8783e0a9a5079d25536978 Mon Sep 17 00:00:00 2001
From: betalars <contact@betalars.de>
Date: Thu, 24 Oct 2024 01:07:52 +0200
Subject: [PATCH] AudioEffectFilter and StereoEnhance: Documentation
 improvements

---
 doc/classes/AudioEffectFilter.xml        | 5 +++++
 doc/classes/AudioEffectStereoEnhance.xml | 4 +++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml
index e5c1f4ccf4e..18540de736e 100644
--- a/doc/classes/AudioEffectFilter.xml
+++ b/doc/classes/AudioEffectFilter.xml
@@ -14,6 +14,7 @@
 			Threshold frequency for the filter, in Hz.
 		</member>
 		<member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB" default="0">
+			Steepness of the cutoff curve in dB per octave, also known as the order of the filter. Higher orders have a more aggressive cutoff.
 		</member>
 		<member name="gain" type="float" setter="set_gain" getter="get_gain" default="1.0">
 			Gain amount of the frequencies after the filter.
@@ -24,12 +25,16 @@
 	</members>
 	<constants>
 		<constant name="FILTER_6DB" value="0" enum="FilterDB">
+			Cutting off at 6dB per octave.
 		</constant>
 		<constant name="FILTER_12DB" value="1" enum="FilterDB">
+			Cutting off at 12dB per octave.
 		</constant>
 		<constant name="FILTER_18DB" value="2" enum="FilterDB">
+			Cutting off at 18dB per octave.
 		</constant>
 		<constant name="FILTER_24DB" value="3" enum="FilterDB">
+			Cutting off at 24dB per octave.
 		</constant>
 	</constants>
 </class>
diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml
index f009bec5bba..459ae3ebc6c 100644
--- a/doc/classes/AudioEffectStereoEnhance.xml
+++ b/doc/classes/AudioEffectStereoEnhance.xml
@@ -11,11 +11,13 @@
 	</tutorials>
 	<members>
 		<member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout" default="1.0">
-			Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono.
+			Amplifies the difference between stereo channels, increasing or decreasing existing panning. A value of 0.0 will downmix stereo to mono. Does not affect a mono signal.
 		</member>
 		<member name="surround" type="float" setter="set_surround" getter="get_surround" default="0.0">
+			Widens sound stage through phase shifting in conjunction with [member time_pullout_ms]. Just pans sound to the left channel if [member time_pullout_ms] is 0.
 		</member>
 		<member name="time_pullout_ms" type="float" setter="set_time_pullout" getter="get_time_pullout" default="0.0">
+			Widens sound stage through phase shifting in conjunction with [member surround]. Just delays the right channel if [member surround] is 0.
 		</member>
 	</members>
 </class>