From 017e6e8a4c310dfd5cb6be2e72009ff2f24fcbcd Mon Sep 17 00:00:00 2001
From: aarroz <aarroz@users.noreply.github.com>
Date: Tue, 12 Sep 2017 06:01:55 -0700
Subject: Added descriptions to AudioEffect, AudioEffectAmplify, and
 AudioEffecChorus

---
 doc/base/classes.xml | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index ea74007482..8ac8dcd88b 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -6418,8 +6418,10 @@
 </class>
 <class name="AudioEffect" inherits="Resource" category="Core">
 	<brief_description>
+		Audio Effect For Audio.
 	</brief_description>
 	<description>
+		Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.
 	</description>
 	<methods>
 	</methods>
@@ -6428,14 +6430,17 @@
 </class>
 <class name="AudioEffectAmplify" inherits="AudioEffect" category="Core">
 	<brief_description>
+		Amplifies the volume of an audio source.
 	</brief_description>
 	<description>
+		Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus.
 	</description>
 	<methods>
 		<method name="get_volume_db" qualifiers="const">
 			<return type="float">
 			</return>
 			<description>
+				Returns the set maximum volume.
 			</description>
 		</method>
 		<method name="set_volume_db">
@@ -6444,11 +6449,13 @@
 			<argument index="0" name="volume" type="float">
 			</argument>
 			<description>
+				Sets the maximum volume.
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" brief="">
+			The effect's volume limit.
 		</member>
 	</members>
 	<constants>
@@ -6476,20 +6483,24 @@
 </class>
 <class name="AudioEffectChorus" inherits="AudioEffect" category="Core">
 	<brief_description>
+		Adds a chorus audio effect.
 	</brief_description>
 	<description>
+		Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
 	</description>
 	<methods>
 		<method name="get_dry" qualifiers="const">
 			<return type="float">
 			</return>
 			<description>
+				Returns the set dry ratio.
 			</description>
 		</method>
 		<method name="get_voice_count" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
+				Returns the set voice count.
 			</description>
 		</method>
 		<method name="get_voice_cutoff_hz" qualifiers="const">
@@ -6498,6 +6509,7 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice's set cutoff frequency.
 			</description>
 		</method>
 		<method name="get_voice_delay_ms" qualifiers="const">
@@ -6506,6 +6518,7 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice's set delay.
 			</description>
 		</method>
 		<method name="get_voice_depth_ms" qualifiers="const">
@@ -6514,6 +6527,7 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice's set filter depth.
 			</description>
 		</method>
 		<method name="get_voice_level_db" qualifiers="const">
@@ -6522,6 +6536,7 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice's set maximum volume.
 			</description>
 		</method>
 		<method name="get_voice_pan" qualifiers="const">
@@ -6530,6 +6545,7 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice's set pan.
 			</description>
 		</method>
 		<method name="get_voice_rate_hz" qualifiers="const">
@@ -6538,12 +6554,14 @@
 			<argument index="0" name="voice_idx" type="int">
 			</argument>
 			<description>
+				Returns the voice filter's set rate in cycles.
 			</description>
 		</method>
 		<method name="get_wet" qualifiers="const">
 			<return type="float">
 			</return>
 			<description>
+				Returns the set applied wetness of the effect.
 			</description>
 		</method>
 		<method name="set_dry">
@@ -6552,6 +6570,7 @@
 			<argument index="0" name="amount" type="float">
 			</argument>
 			<description>
+				Returns the set applied dryness of the effect.
 			</description>
 		</method>
 		<method name="set_voice_count">
@@ -6560,6 +6579,7 @@
 			<argument index="0" name="voices" type="int">
 			</argument>
 			<description>
+				Set the number of voices in the effect's filter.
 			</description>
 		</method>
 		<method name="set_voice_cutoff_hz">
@@ -6570,6 +6590,7 @@
 			<argument index="1" name="cutoff_hz" type="float">
 			</argument>
 			<description>
+				Set the cutoff frequency of the voice. The maximum frequency the voice may affect.
 			</description>
 		</method>
 		<method name="set_voice_delay_ms">
@@ -6580,6 +6601,7 @@
 			<argument index="1" name="delay_ms" type="float">
 			</argument>
 			<description>
+				Set the delay of the voice's signal.
 			</description>
 		</method>
 		<method name="set_voice_depth_ms">
@@ -6590,6 +6612,7 @@
 			<argument index="1" name="depth_ms" type="float">
 			</argument>
 			<description>
+				Set the filter depth of the voice's signal.
 			</description>
 		</method>
 		<method name="set_voice_level_db">
@@ -6600,6 +6623,7 @@
 			<argument index="1" name="level_db" type="float">
 			</argument>
 			<description>
+				Set the volume level of the voice.
 			</description>
 		</method>
 		<method name="set_voice_pan">
@@ -6610,6 +6634,7 @@
 			<argument index="1" name="pan" type="float">
 			</argument>
 			<description>
+				Set the pan level of the voice.
 			</description>
 		</method>
 		<method name="set_voice_rate_hz">
@@ -6620,6 +6645,7 @@
 			<argument index="1" name="rate_hz" type="float">
 			</argument>
 			<description>
+				Set the voice filter's rate.
 			</description>
 		</method>
 		<method name="set_wet">
@@ -6628,63 +6654,91 @@
 			<argument index="0" name="amount" type="float">
 			</argument>
 			<description>
+				Set the amount of effect.
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="dry" type="float" setter="set_dry" getter="get_dry" brief="">
+			The effect's raw signal.
 		</member>
 		<member name="voice/1/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" brief="">
+			The voice's cutoff frequency.
 		</member>
 		<member name="voice/1/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" brief="">
+			The voice's signal delay.
 		</member>
 		<member name="voice/1/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" brief="">
+			The voice filter's depth.
 		</member>
 		<member name="voice/1/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" brief="">
+			The voice's volume.
 		</member>
 		<member name="voice/1/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" brief="">
+			The voice's pan level.
 		</member>
 		<member name="voice/1/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" brief="">
+			The voice's filter rate.
 		</member>
 		<member name="voice/2/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" brief="">
+			The voice's cutoff frequency.
 		</member>
 		<member name="voice/2/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" brief="">
+			The voice's signal delay.
 		</member>
 		<member name="voice/2/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" brief="">
+			The voice filter's depth.
 		</member>
 		<member name="voice/2/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" brief="">
+			The voice's volume.
 		</member>
 		<member name="voice/2/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" brief="">
+			The voice's pan level.
 		</member>
 		<member name="voice/2/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" brief="">
+			The voice's filter rate.
 		</member>
 		<member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" brief="">
+			The voice's cutoff frequency.
 		</member>
 		<member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" brief="">
+			The voice's signal delay.
 		</member>
 		<member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" brief="">
+			The voice filter's depth.
 		</member>
 		<member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" brief="">
+			The voice's volume.
 		</member>
 		<member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" brief="">
+			The voice's pan level.
 		</member>
 		<member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" brief="">
+			The voice's filter rate.
 		</member>
 		<member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" brief="">
+			The voice's cutoff frequency.
 		</member>
 		<member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" brief="">
+			The voice's signal delay.
 		</member>
 		<member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" brief="">
+			The voice filter's depth.
 		</member>
 		<member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" brief="">
+			The voice's volume.
 		</member>
 		<member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" brief="">
+			The voice's pan level.
 		</member>
 		<member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" brief="">
+			The voice's filter rate.
 		</member>
 		<member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count" brief="">
+			The amount of voices in the effect.
 		</member>
 		<member name="wet" type="float" setter="set_wet" getter="get_wet" brief="">
+			The effect's processed signal.
 		</member>
 	</members>
 	<constants>
-- 
cgit v1.2.3