From ab4ea9379c024f18824f3f6f93c18d660ce678ef Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Wed, 15 Apr 2020 23:38:12 +0200
Subject: [PATCH] Improve the AudioStreamSample class documentation

This closes #37915.

(cherry picked from commit 52786b54ef5e7b86286a5d3cefe531a0efa7400e)
---
 doc/classes/AudioStreamSample.xml | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml
index 873aae34985..898e3e43d7c 100644
--- a/doc/classes/AudioStreamSample.xml
+++ b/doc/classes/AudioStreamSample.xml
@@ -30,13 +30,13 @@
 			Audio format. See [enum Format] constants for values.
 		</member>
 		<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin" default="0">
-			Loop start in bytes.
+			The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
 		</member>
 		<member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end" default="0">
-			Loop end in bytes.
+			The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
 		</member>
 		<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode" default="0">
-			Loop mode. See [enum LoopMode] constants for values.
+			The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.
 		</member>
 		<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate" default="44100">
 			The sample rate for mixing this audio.
@@ -59,13 +59,13 @@
 			Audio does not loop.
 		</constant>
 		<constant name="LOOP_FORWARD" value="1" enum="LoopMode">
-			Audio loops the data between [member loop_begin] and [member loop_end] playing forward only.
+			Audio loops the data between [member loop_begin] and [member loop_end], playing forward only.
 		</constant>
 		<constant name="LOOP_PING_PONG" value="2" enum="LoopMode">
-			Audio loops the data between [member loop_begin] and [member loop_end] playing back and forth.
+			Audio loops the data between [member loop_begin] and [member loop_end], playing back and forth.
 		</constant>
 		<constant name="LOOP_BACKWARD" value="3" enum="LoopMode">
-			Audio loops the data between [member loop_begin] and [member loop_end] playing backward only.
+			Audio loops the data between [member loop_begin] and [member loop_end], playing backward only.
 		</constant>
 	</constants>
 </class>