From bc667aeada757463fbb562eb262d404968f0ca37 Mon Sep 17 00:00:00 2001
From: Henrique Campos <henriiquecampos@gmail.com>
Date: Sat, 21 Oct 2017 13:45:27 -0200
Subject: Added description to Audio Filter Effects

Also doccumented Filter member variables and methods.
[ci skip]
---
 doc/classes/AudioEffectBandLimitFilter.xml | 2 ++
 doc/classes/AudioEffectBandPassFilter.xml  | 2 ++
 doc/classes/AudioEffectFilter.xml          | 6 ++++++
 doc/classes/AudioEffectHighPassFilter.xml  | 2 ++
 doc/classes/AudioEffectLowPassFilter.xml   | 2 ++
 doc/classes/AudioEffectNotchFilter.xml     | 2 ++
 6 files changed, 16 insertions(+)

(limited to 'doc/classes')

diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml
index 96f95fbffd..d4b251fc8e 100644
--- a/doc/classes/AudioEffectBandLimitFilter.xml
+++ b/doc/classes/AudioEffectBandLimitFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a band limit filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Limits the frequencies in a range around the [member cutoff_hz] and allows frequencies outside of this range to pass.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml
index 4437961cc6..b5c6ae3c20 100644
--- a/doc/classes/AudioEffectBandPassFilter.xml
+++ b/doc/classes/AudioEffectBandPassFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a band pass filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Attenuates the frequencies inside of a range around the [member cutoff_hz] and cuts frequencies outside of this band.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml
index 17aa01d60a..dc547c9fe5 100644
--- a/doc/classes/AudioEffectFilter.xml
+++ b/doc/classes/AudioEffectFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Allows frequencies other than the [member cutoff_hz] to pass.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -68,12 +70,16 @@
 	</methods>
 	<members>
 		<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff">
+			Threshold frequency for the filter.
 		</member>
 		<member name="dB" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB">
+			The volume in decibels of the filter.
 		</member>
 		<member name="gain" type="float" setter="set_gain" getter="get_gain">
+			Gain amount of the frequences after the filter.
 		</member>
 		<member name="resonance" type="float" setter="set_resonance" getter="get_resonance">
+			Amount of boost in the overtones near the cutoff frequency.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml
index 641f7cfee2..c5e24af510 100644
--- a/doc/classes/AudioEffectHighPassFilter.xml
+++ b/doc/classes/AudioEffectHighPassFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a high pass filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Cuts frequencies lower than the [member cutoff_hz] and allows higher frequencies to pass.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml
index fcaf32d761..f102dda03e 100644
--- a/doc/classes/AudioEffectLowPassFilter.xml
+++ b/doc/classes/AudioEffectLowPassFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a low pass filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Cuts frequencies higher than the [member cutoff_hz] and allows lower frequencies to pass.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml
index f90577fa5a..8ec9a4bc7c 100644
--- a/doc/classes/AudioEffectNotchFilter.xml
+++ b/doc/classes/AudioEffectNotchFilter.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Adds a notch filter to the Audio Bus.
 	</brief_description>
 	<description>
+		Attenuates frequencies in a narrow band around the [member cutoff_hz] and cuts frequencies outside of this range.
 	</description>
 	<tutorials>
 	</tutorials>
-- 
cgit v1.2.3