From 51c8f38aa865a7abe1b0de27575689b75a986853 Mon Sep 17 00:00:00 2001 From: Thijs Vermeir Date: Fri, 1 Feb 2008 18:29:21 +0000 Subject: Add documentation for avisubtitle and change class to Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * gst/avi/gstavisubtitle.c: Add documentation for avisubtitle and change class to Codec/Parser/Subtitle --- gst/avi/gstavisubtitle.c | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'gst/avi/gstavisubtitle.c') diff --git a/gst/avi/gstavisubtitle.c b/gst/avi/gstavisubtitle.c index 4b498b35..38771c38 100644 --- a/gst/avi/gstavisubtitle.c +++ b/gst/avi/gstavisubtitle.c @@ -18,7 +18,24 @@ * Boston, MA 02111-1307, USA. */ -/* FIXME: documentation */ +/** + * SECTION:element-avisubtitle + * + * + * + * Parses the subtitle stream from an avi file. + * + * Example launch line + * + * + * gst-launch filesrc location=subtitle.avi ! avidemux name=demux ! queue ! avisubtitle ! subparse ! textoverlay name=overlay ! ffmpegcolorspace ! autovideosink demux. ! queue ! decodebin ! overlay. + * + * This plays an avi file with a video and subtitle stream. + * + * + * + * Last reviewed on 2008-02-01 + */ /* example of a subtitle chunk in an avi file * 00000000: 47 41 42 32 00 02 00 10 00 00 00 45 00 6e 00 67 GAB2.......E.n.g @@ -298,8 +315,8 @@ gst_avi_subtitle_base_init (gpointer klass) gst_static_pad_template_get (&src_template)); gst_element_class_set_details_simple (element_class, - "Avi subtitle parser", "Codec/Demuxer", "Parse avi subtitle stream", - "Thijs Vermeir "); + "Avi subtitle parser", "Codec/Parser/Subtitle", + "Parse avi subtitle stream", "Thijs Vermeir "); } static void -- cgit