From 12fe7748449d76495f7ab2f240b1754b54c8a2f1 Mon Sep 17 00:00:00 2001
From: Chris Bradfield <chris@kidscancode.org>
Date: Sun, 20 May 2018 13:43:48 -0700
Subject: [PATCH] [DOCS] Update VideoPlayer classref

(cherry picked from commit 393125a6a4bbe97f4e7ebe3ac5e652a321be324c)
---
 doc/classes/TextureRect.xml |  8 ++++----
 doc/classes/VideoPlayer.xml | 31 ++++++++++++++++++++++---------
 2 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml
index 1eb506f8b94..803cf5b8146 100644
--- a/doc/classes/TextureRect.xml
+++ b/doc/classes/TextureRect.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="TextureRect" inherits="Control" category="Core" version="3.0.2">
 	<brief_description>
-		Draws a sprite or a texture inside a User Interface. The texture can tile or not.
+		Control for drawing textures.
 	</brief_description>
 	<description>
-		Use TextureRect to draw icons and sprites in your User Interfaces. To create panels and menu boxes, take a look at [NinePatchFrame]. Its Stretch Mode property controls the texture's scale and placement. It can scale, tile and stay centered inside its bounding rectangle. TextureRect is one of the 5 most common nodes to create game UI.
+		Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the [member stretch_mode] property. It can scale, tile, or stay centered inside its bounding rectangle.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -14,10 +14,10 @@
 	</methods>
 	<members>
 		<member name="expand" type="bool" setter="set_expand" getter="has_expand">
-			If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code].
+			If [code]true[/code] the texture scales to fit its bounding rectangle. Default value: [code]false[/code].
 		</member>
 		<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode">
-			Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more.
+			Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode].
 		</member>
 		<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
 			The node's [Texture] resource.
diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml
index 95a4979e663..2b91f4cf30a 100644
--- a/doc/classes/VideoPlayer.xml
+++ b/doc/classes/VideoPlayer.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VideoPlayer" inherits="Control" category="Core" version="3.0.2">
 	<brief_description>
-		Control to play video files.
+		Control for playing video streams.
 	</brief_description>
 	<description>
-		This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.
+		Control node for playing video streams. Supported formats are WebM and OGV Theora.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -15,51 +15,56 @@
 			<return type="String">
 			</return>
 			<description>
-				Get the name of the video stream.
+				Returns the video stream's name.
 			</description>
 		</method>
 		<method name="get_video_texture">
 			<return type="Texture">
 			</return>
 			<description>
-				Get the current frame of the video as a [Texture].
+				Returns the current frame as a [Texture].
 			</description>
 		</method>
 		<method name="is_playing" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
-				Get whether or not the video is playing.
+				Returns [code]true[/code] if the video is playing.
 			</description>
 		</method>
 		<method name="play">
 			<return type="void">
 			</return>
 			<description>
-				Start the video playback.
+				Starts the video playback.
 			</description>
 		</method>
 		<method name="stop">
 			<return type="void">
 			</return>
 			<description>
-				Stop the video playback.
+				Stops the video playback.
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track">
+			The embedded audio track to play.
 		</member>
 		<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
+			If [code]true[/code] playback starts when the scene loads. Default value: [code]false[/code].
 		</member>
 		<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec">
-			The amount of milliseconds to store in buffer while playing.
+			Amount of time in milliseconds to store in buffer while playing.
 		</member>
 		<member name="bus" type="String" setter="set_bus" getter="get_bus">
+			Audio bus to use for sound playback.
 		</member>
 		<member name="expand" type="bool" setter="set_expand" getter="has_expand">
+			If [code]true[/code] the video scales to the control size. Default value: [code]true[/code].
 		</member>
 		<member name="paused" type="bool" setter="set_paused" getter="is_paused">
+			If [code]true[/code] the video is paused.
 		</member>
 		<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
 		</member>
@@ -67,11 +72,19 @@
 			The current position of the stream, in seconds.
 		</member>
 		<member name="volume" type="float" setter="set_volume" getter="get_volume">
-			The volume of the audio track as a linear value.
+			Audio volume as a linear value.
 		</member>
 		<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
+			Audio volume in dB.
 		</member>
 	</members>
+	<signals>
+		<signal name="finished">
+			<description>
+				Emitted when playback is finished.
+			</description>
+		</signal>
+	</signals>
 	<constants>
 	</constants>
 </class>