Document whats first shown on the fdo plugin docs page :)

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:
* ext/raw1394/gstdv1394src.c:
Document whats first shown on the fdo plugin docs page :)

diff --git a/ChangeLog b/ChangeLog
index 6c6ee4d..94c3165 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -3,6 +3,14 @@
        * docs/plugins/Makefile.am:
        * docs/plugins/gst-plugins-good-plugins-docs.sgml:
        * docs/plugins/gst-plugins-good-plugins-sections.txt:
+       * ext/raw1394/gstdv1394src.c:
+         Document whats first shown on the fdo plugin docs page :)
+
+2008-05-28  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/plugins/Makefile.am:
+       * docs/plugins/gst-plugins-good-plugins-docs.sgml:
+       * docs/plugins/gst-plugins-good-plugins-sections.txt:
        * docs/plugins/gst-plugins-good-plugins.args:
        * docs/plugins/gst-plugins-good-plugins.hierarchy:
        * docs/plugins/inspect/plugin-audiofx.xml:

diff --git a/common b/common
index 032f2d9..130fa8f 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit 032f2d973bd5c9a9b457cb5fc72d13dafe85c01e
+Subproject commit 130fa8f739ff09aedb520c33239f53d06cfe9bd5

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 00d31b8..008aa1f 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -94,6 +94,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/libcaca/gstcacasink.h \
        $(top_srcdir)/ext/libpng/gstpngdec.h \
        $(top_srcdir)/ext/libpng/gstpngenc.h \
+       $(top_srcdir)/ext/raw1394/gstdv1394src.h \
        $(top_srcdir)/ext/soup/gstsouphttpsrc.h \
        $(top_srcdir)/ext/taglib/gstapev2mux.h \
        $(top_srcdir)/ext/taglib/gstid3v2mux.h \

diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 1dea9b9..c5fdb27 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -37,6 +37,7 @@
     <xi:include href="xml/element-cmmlenc.xml" />
     <xi:include href="xml/element-directdrawsink.xml" />
     <xi:include href="xml/element-directsoundsink.xml" />
+    <xi:include href="xml/element-dv1394src.xml" />
     <xi:include href="xml/element-dvdec.xml" />
     <xi:include href="xml/element-dvdemux.xml" />
     <xi:include href="xml/element-equalizer-10bands.xml" />

diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index b30bc3c..d35edaf 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -391,6 +391,20 @@ GST_DSOUND_UNLOCK
 </SECTION>
 
 <SECTION>
+<FILE>element-dv1394src</FILE>
+<TITLE>dv1394src</TITLE>
+GstDV1394Src
+<SUBSECTION Standard>
+GstDV1394SrcClass
+GST_TYPE_DV1394SRC
+GST_DV1394SRC
+GST_DV1394SRC_CLASS
+GST_IS_DV1394SRC
+GST_IS_DV1394SRC_CLASS
+gst_dv1394src_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-dvdec</FILE>
 <TITLE>dvdec</TITLE>
 GstDVDec

diff --git a/ext/raw1394/gstdv1394src.c b/ext/raw1394/gstdv1394src.c
index 34a354f..e5ea288 100644 (file)
--- a/ext/raw1394/gstdv1394src.c
+++ b/ext/raw1394/gstdv1394src.c
@@ -19,6 +19,23 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-dv1394src
+ *
+ * <refsect2>
+ * <para>
+ * Read DV (digital video) data from firewire port.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch dv1394src ! dvdemux name=d ! queue ! dvdec ! xvimagesink d. ! queue ! alsasink
+ * </programlisting>
+ * This pipeline captures from the firewire port and displays it (might need
+ * format converters for audio/video).
+ * </para>
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"