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

diff --git a/ChangeLog b/ChangeLog
index b2e5a28..d126716 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2008-02-01  Thijs Vermeir  <thijsvermeir@gmail.com>
+
+       * 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
+
 2008-01-31  Jan Schmidt  <Jan.Schmidt@sun.com>
 
        * sys/v4l2/v4l2_calls.c: (gst_v4l2_fill_lists):

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 0cb76ac..ab6654c 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -106,6 +106,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/autodetect/gstautovideosink.h \
        $(top_srcdir)/gst/avi/gstavidemux.h \
        $(top_srcdir)/gst/avi/gstavimux.h \
+       $(top_srcdir)/gst/avi/gstavisubtitle.h \
        $(top_srcdir)/gst/debug/progressreport.h \
        $(top_srcdir)/gst/goom/gstgoom.h \
        $(top_srcdir)/gst/icydemux/gsticydemux.h \

diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index cc996d9..1e8394a 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -25,6 +25,7 @@
     <xi:include href="xml/element-autovideosink.xml" />
     <xi:include href="xml/element-avidemux.xml" />
     <xi:include href="xml/element-avimux.xml" />
+    <xi:include href="xml/element-avisubtitle.xml" />
     <xi:include href="xml/element-cairotimeoverlay.xml" />
     <xi:include href="xml/element-cdiocddasrc.xml" />
     <xi:include href="xml/element-cmmldec.xml" />

diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 4f1168b..06897f7 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -210,6 +210,20 @@ gst_avi_mux_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-avisubtitle</FILE>
+<TITLE>avisubtitle</TITLE>
+GstAviSubtitle
+<SUBSECTION Standard>
+GstAviSubtitleClass
+GST_TYPE_AVI_SUBTITLE
+GST_AVI_SUBTITLE
+GST_AVI_SUBTITLE_CLASS
+GST_IS_AVI_SUBTITLE
+GST_IS_AVI_SUBTITLE_CLASS
+gst_avi_subtitle_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-cairotimeoverlay</FILE>
 <TITLE>cairotimeoverlay</TITLE>
 GstCairoTimeOverlay

diff --git a/gst/avi/gstavisubtitle.c b/gst/avi/gstavisubtitle.c
index 4b498b3..38771c3 100644 (file)
--- a/gst/avi/gstavisubtitle.c
+++ b/gst/avi/gstavisubtitle.c
@@ -18,7 +18,24 @@
  * Boston, MA 02111-1307, USA.
  */
 
-/* FIXME: documentation */
+/**
+ * SECTION:element-avisubtitle
+ *
+ * <refsect2>
+ * <para>
+ * Parses the subtitle stream from an avi file.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=subtitle.avi ! avidemux name=demux ! queue ! avisubtitle ! subparse ! textoverlay name=overlay ! ffmpegcolorspace ! autovideosink demux. ! queue ! decodebin ! overlay.
+ * </programlisting>
+ * This plays an avi file with a video and subtitle stream.
+ * </para>
+ * </refsect2>
+ *
+ * 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 <thijsvermeir@gmail.com>");
+      "Avi subtitle parser", "Codec/Parser/Subtitle",
+      "Parse avi subtitle stream", "Thijs Vermeir <thijsvermeir@gmail.com>");
 }
 
 static void