From 4823d998fcff37589719ff42ca40893564930fcf Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Mon, 13 Oct 2014 10:32:07 +0200 Subject: [PATCH] validate:launcher: Minor enhancement in the documentation --- validate/docs/launcher/conf.py | 1 + validate/tools/launcher/baseclasses.py | 15 +++++++++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/validate/docs/launcher/conf.py b/validate/docs/launcher/conf.py index a2ff489a88..dadd75ae5d 100644 --- a/validate/docs/launcher/conf.py +++ b/validate/docs/launcher/conf.py @@ -240,3 +240,4 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' +autoclass_content = 'both' diff --git a/validate/tools/launcher/baseclasses.py b/validate/tools/launcher/baseclasses.py index 4069039f6b..698c2b21a0 100644 --- a/validate/tools/launcher/baseclasses.py +++ b/validate/tools/launcher/baseclasses.py @@ -1026,7 +1026,7 @@ class GstValidateBaseTestManager(TestsManager): def add_scenarios(self, scenarios): """ - @scenarios: A list or a unic scenario name(s) to be run on the tests. + @scenarios A list or a unic scenario name(s) to be run on the tests. They are just the default scenarios, and then depending on the TestsGenerator to be used you can have more fine grained control on what to be run on each serie of tests. @@ -1042,7 +1042,7 @@ class GstValidateBaseTestManager(TestsManager): def add_encoding_formats(self, encoding_formats): """ - @encoding_formats: A list or one single #MediaFormatCombinations describing wanted output + :param encoding_formats: A list or one single #MediaFormatCombinations describing wanted output formats for transcoding test. They are just the default encoding formats, and then depending on the TestsGenerator to be used you can have more fine grained @@ -1226,7 +1226,7 @@ class GstValidateMediaDescriptor(MediaDescriptor): return name.replace('.', "_") class MediaFormatCombination(object): - _FORMATS = {"aac": "audio/mpeg,mpegversion=4", + FORMATS = {"aac": "audio/mpeg,mpegversion=4", "ac3": "audio/x-ac3", "vorbis": "audio/x-vorbis", "mp3": "audio/mpeg,mpegversion=1,layer=3", @@ -1243,13 +1243,20 @@ class MediaFormatCombination(object): return "%s and %s in %s" % (self.audio, self.video, self.container) def __init__(self, container, audio, video): + """ + Describes a media format to be used for transcoding tests. + + :param container: A string defining the container format to be used, must bin in self.FORMATS + :param audio: A string defining the audio format to be used, must bin in self.FORMATS + :param video: A string defining the video format to be used, must bin in self.FORMATS + """ self.container = container self.audio = audio self.video = video def get_caps(self, track_type): try: - return self._FORMATS[self.__dict__[track_type]] + return self.FORMATS[self.__dict__[track_type]] except KeyError: return None