From 10269b74c84d15301bcb21ec0156f4b2b2457cb6 Mon Sep 17 00:00:00 2001
From: Grosskopf <gerrit@familiegrosskopf.de>
Date: Sat, 16 Sep 2017 23:12:52 +0200
Subject: [PATCH] Added Documentation of AudioStream

---
 doc/classes/AudioStreamOGGVorbis.xml   |  3 +++
 doc/classes/AudioStreamRandomPitch.xml |  4 ++++
 doc/classes/AudioStreamSample.xml      | 15 +++++++++++++++
 3 files changed, 22 insertions(+)

diff --git a/doc/classes/AudioStreamOGGVorbis.xml b/doc/classes/AudioStreamOGGVorbis.xml
index fd9018764d3..679438b66b1 100644
--- a/doc/classes/AudioStreamOGGVorbis.xml
+++ b/doc/classes/AudioStreamOGGVorbis.xml
@@ -56,10 +56,13 @@
 	</methods>
 	<members>
 		<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
+			Raw audio data.
 		</member>
 		<member name="loop" type="bool" setter="set_loop" getter="has_loop">
+			If [code]true[/code], audio will loop continuously. Default value: [code]false[/code].
 		</member>
 		<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset">
+			If loop is [code]true[/code], loop starts from this position, in seconds.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml
index 91856682e6d..1573a78d1fc 100644
--- a/doc/classes/AudioStreamRandomPitch.xml
+++ b/doc/classes/AudioStreamRandomPitch.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Plays audio with random pitch tweaking.
 	</brief_description>
 	<description>
+		Randomly varies pitch on each start.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -40,8 +42,10 @@
 	</methods>
 	<members>
 		<member name="audio_stream" type="AudioStream" setter="set_audio_stream" getter="get_audio_stream">
+			The current [AudioStream].
 		</member>
 		<member name="random_pitch" type="float" setter="set_random_pitch" getter="get_random_pitch">
+			The intensity of random pitch variation.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml
index 22b820aa7dc..7f7414e4d34 100644
--- a/doc/classes/AudioStreamSample.xml
+++ b/doc/classes/AudioStreamSample.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Plays audio.
 	</brief_description>
 	<description>
+		Plays audio, can loop.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -110,32 +112,45 @@
 	</methods>
 	<members>
 		<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
+			Raw audio data.
 		</member>
 		<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
+			Audio format. See FORMAT_* constants for values.
 		</member>
 		<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin">
+			Loop start in bytes.
 		</member>
 		<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end">
+			Loop end in bytes.
 		</member>
 		<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode">
+			Loop mode. See LOOP_* constants for values.
 		</member>
 		<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate">
+			The sample rate for mixing this audio.
 		</member>
 		<member name="stereo" type="bool" setter="set_stereo" getter="is_stereo">
+			If [code]true[/code], audio is stereo. Default value: [code]false[/code].
 		</member>
 	</members>
 	<constants>
 		<constant name="FORMAT_8_BITS" value="0">
+			Audio codec 8 bit.
 		</constant>
 		<constant name="FORMAT_16_BITS" value="1">
+			Audio codec 16 bit.
 		</constant>
 		<constant name="FORMAT_IMA_ADPCM" value="2">
+			Audio codec IMA ADPCM.
 		</constant>
 		<constant name="LOOP_DISABLED" value="0">
+			Audio does not loop.
 		</constant>
 		<constant name="LOOP_FORWARD" value="1">
+			Audio loops the data between loop_begin and loop_end playing forward only.
 		</constant>
 		<constant name="LOOP_PING_PONG" value="2">
+			Audio loops the data between loop_begin and loop_end playing back and forth.
 		</constant>
 	</constants>
 </class>