summaryrefslogtreecommitdiff
path: root/modules/webm/doc_classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:24:14 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:29:07 +0100
commitbb6c0d3e8bb1982bce3e1c219c1a4a2d187227f0 (patch)
treeee58635301c11a4e5e46d99030e54cff3e4ca9ba /modules/webm/doc_classes
parent55cc46a0523df8df85aa6ffec6b58ff86e5ab1af (diff)
doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
Diffstat (limited to 'modules/webm/doc_classes')
-rw-r--r--modules/webm/doc_classes/VideoStreamWebm.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/webm/doc_classes/VideoStreamWebm.xml b/modules/webm/doc_classes/VideoStreamWebm.xml
index ff11bbb37d..4807672338 100644
--- a/modules/webm/doc_classes/VideoStreamWebm.xml
+++ b/modules/webm/doc_classes/VideoStreamWebm.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamWebm" inherits="VideoStream" category="Core" version="3.2">
<brief_description>
+ [VideoStream] resource for WebM videos.
</brief_description>
<description>
+ [VideoStream] resource handling the [url=https://www.webmproject.org/]WebM[/url] video format with [code].webm[/code] extension.
</description>
<tutorials>
</tutorials>
@@ -11,6 +13,7 @@
<return type="String">
</return>
<description>
+ Returns the WebM video file handled by this [VideoStreamWebm].
</description>
</method>
<method name="set_file">
@@ -19,6 +22,7 @@
<argument index="0" name="file" type="String">
</argument>
<description>
+ Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension.
</description>
</method>
</methods>