From bb6c0d3e8bb1982bce3e1c219c1a4a2d187227f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Sun, 26 Jan 2020 11:24:14 +0100
Subject: doc: Complete documentation for VideoStreams

Also quick clean up of the matching C++ files.
---
 modules/theora/doc_classes/VideoStreamTheora.xml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'modules/theora/doc_classes')

diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml
index 696101e252..ab1fcdcfb4 100644
--- a/modules/theora/doc_classes/VideoStreamTheora.xml
+++ b/modules/theora/doc_classes/VideoStreamTheora.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="VideoStreamTheora" inherits="VideoStream" category="Core" version="3.2">
 	<brief_description>
+		[VideoStream] resource for Ogg Theora videos.
 	</brief_description>
 	<description>
+		[VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -11,6 +13,7 @@
 			<return type="String">
 			</return>
 			<description>
+				Returns the Ogg Theora video file handled by this [VideoStreamTheora].
 			</description>
 		</method>
 		<method name="set_file">
@@ -19,6 +22,7 @@
 			<argument index="0" name="file" type="String">
 			</argument>
 			<description>
+				Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].o[/code] extension.
 			</description>
 		</method>
 	</methods>
-- 
cgit v1.2.3