diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-11-15 21:54:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-15 21:54:21 +0100 |
| commit | c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch) | |
| tree | a22a88d22bd079a8404150fbf5b870df6046240e /modules/theora | |
| parent | 4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff) | |
| parent | 11e07d18bd80c0b7d8836698d98e058750e33660 (diff) | |
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/theora')
| -rw-r--r-- | modules/theora/config.py | 11 | ||||
| -rw-r--r-- | modules/theora/doc_classes/ResourceImporterTheora.xml | 15 | ||||
| -rw-r--r-- | modules/theora/doc_classes/VideoStreamTheora.xml | 33 |
3 files changed, 57 insertions, 2 deletions
diff --git a/modules/theora/config.py b/modules/theora/config.py index fb920482f5..34d34f8be2 100644 --- a/modules/theora/config.py +++ b/modules/theora/config.py @@ -1,7 +1,14 @@ - def can_build(platform): return True - def configure(env): pass + +def get_doc_classes(): + return [ + "ResourceImporterTheora", + "VideoStreamTheora", + ] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/theora/doc_classes/ResourceImporterTheora.xml b/modules/theora/doc_classes/ResourceImporterTheora.xml new file mode 100644 index 0000000000..497c938826 --- /dev/null +++ b/modules/theora/doc_classes/ResourceImporterTheora.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceImporterTheora" inherits="ResourceImporter" category="Core" version="3.0-alpha"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml new file mode 100644 index 0000000000..8f155b786f --- /dev/null +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VideoStreamTheora" inherits="VideoStream" category="Core" version="3.0-alpha"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_file"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_file"> + <return type="void"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="file" type="String" setter="set_file" getter="get_file"> + </member> + </members> + <constants> + </constants> +</class> |