document flacdec

Original commit message from CVS:
document flacdec

diff --git a/ChangeLog b/ChangeLog
index 5d1cf47..2aa4543 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/flac/gstflacdec.c:
+         document flacdec
+
+2005-11-25  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * docs/plugins/Makefile.am:
+       * docs/plugins/gst-plugins-good-plugins-docs.sgml:
+       * docs/plugins/gst-plugins-good-plugins-sections.txt:
        * docs/plugins/inspect/plugin-autodetect.xml:
        * ext/cairo/gstcairo.c: (plugin_init):
        * ext/cairo/gsttextoverlay.c: (gst_text_overlay_base_init),

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 497e60e..904b30d 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -78,7 +78,8 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/autodetect/gstautovideosink.h \
        $(top_srcdir)/gst/level/gstlevel.h \
        $(top_srcdir)/gst/goom/gstgoom.h \
-       $(top_srcdir)/ext/cairo/gsttimeoverlay.h
+       $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
+       $(top_srcdir)/ext/flac/gstflacdec.h
 
 # example code that needs to be converted to xml and placed in xml/
 EXAMPLE_CFILES = \

diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 9f2b03e..3159bb8 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -15,6 +15,7 @@
     <xi:include href="xml/element-autoaudiosink.xml" />
     <xi:include href="xml/element-autovideosink.xml" />
     <xi:include href="xml/element-cairotimeoverlay.xml" />
+    <xi:include href="xml/element-flacdec.xml" />
     <xi:include href="xml/element-goom.xml" />
     <xi:include href="xml/element-level.xml" />
   </chapter>

diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index fa729f2..2f5b041 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -23,6 +23,14 @@ GstCairoTimeOverlayClass
 </SECTION>
 
 <SECTION>
+<FILE>element-flacdec</FILE>
+GstFlacDec
+<TITLE>flacdec</TITLE>
+<SUBSECTION Standard>
+GstFlacDecClass
+</SECTION>
+
+<SECTION>
 <FILE>element-goom</FILE>
 GstGoom
 <TITLE>goom</TITLE>

diff --git a/ext/flac/gstflacdec.c b/ext/flac/gstflacdec.c
index 485cfad..5f53425 100644 (file)
--- a/ext/flac/gstflacdec.c
+++ b/ext/flac/gstflacdec.c
@@ -17,6 +17,30 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-flacdec
+ * @seealso: flacenc
+ *
+ * <refsect2>
+ * <para>
+ * flacdec decodes FLAC streams.
+ * <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
+ * is a Free Lossless Audio Codec.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=media/small/dark.441-16-s.flac ! flacdec ! autoaudiosink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
+/*
+ * FIXME: this pipeline doesn't work, but we want to use it as example
+ * gst-launch gnomevfssrc location=http://gstreamer.freedesktop.org/media/small/dark.441-16-s.flac ! flacdec ! autoaudiosink
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif