From 044dd6626f9ad21ee6d47d0a18084f8c7b5c0373 Mon Sep 17 00:00:00 2001
From: Thomas Vander Stichele <thomas@apestaart.org>
Date: Fri, 25 Nov 2005 22:14:47 +0000
Subject: [PATCH] document flacdec

Original commit message from CVS:
document flacdec
---
 ChangeLog                                     |  8 +++++++
 docs/plugins/Makefile.am                      |  3 ++-
 .../gst-plugins-good-plugins-docs.sgml        |  1 +
 .../gst-plugins-good-plugins-sections.txt     |  8 +++++++
 ext/flac/gstflacdec.c                         | 24 +++++++++++++++++++
 5 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/ChangeLog b/ChangeLog
index 5d1cf470aa..2aa45435c3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+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:
+	* ext/flac/gstflacdec.c:
+	  document flacdec
+
 2005-11-25  Thomas Vander Stichele  <thomas at apestaart dot org>
 
 	* docs/plugins/Makefile.am:
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 497e60e12d..904b30d1ed 100644
--- 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 9f2b03ebab..3159bb8225 100644
--- 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 fa729f22e6..2f5b041557 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -22,6 +22,14 @@ GstCairoTimeOverlay
 GstCairoTimeOverlayClass
 </SECTION>
 
+<SECTION>
+<FILE>element-flacdec</FILE>
+GstFlacDec
+<TITLE>flacdec</TITLE>
+<SUBSECTION Standard>
+GstFlacDecClass
+</SECTION>
+
 <SECTION>
 <FILE>element-goom</FILE>
 GstGoom
diff --git a/ext/flac/gstflacdec.c b/ext/flac/gstflacdec.c
index 485cfade22..5f534253c4 100644
--- 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