From 7381b4940caefc0335f14478a34f2faf979131df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= <slomo@circular-chaos.org>
Date: Wed, 23 Aug 2006 08:52:50 +0000
Subject: Add docs for wavpack elements (#352476).
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Original commit message from CVS:
Patch by: Sebastian Dröge <slomo at circular-chaos.org>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins.hierarchy:
* docs/plugins/inspect/plugin-wavpack.xml:
* ext/wavpack/gstwavpackdec.c:
* ext/wavpack/gstwavpackdec.h:
* ext/wavpack/gstwavpackenc.c:
* ext/wavpack/gstwavpackenc.h:
* ext/wavpack/gstwavpackparse.c:
* ext/wavpack/gstwavpackparse.h:
Add docs for wavpack elements (#352476).
---
 ext/wavpack/gstwavpackdec.c | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'ext/wavpack/gstwavpackdec.c')

diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c
index 3e61c9a1..1962c9b9 100644
--- a/ext/wavpack/gstwavpackdec.c
+++ b/ext/wavpack/gstwavpackdec.c
@@ -21,6 +21,25 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-wavpackdec
+ *
+ * <refsect2>
+ * wavpackdec decodes framed (for example by the wavpackparse element)
+ * Wavpack streams and decodes them to raw audio.
+ * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
+ * audio codec that features both lossless and lossy encoding.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink
+ * </programlisting>
+ * This pipeline decodes the Wavpack file test.wv into raw audio buffers and
+ * tries to play it back using an automatically found audio sink.
+ * </para>
+ * </refsect2>
+ */
+
 #include <gst/gst.h>
 #include <gst/audio/audio.h>
 
-- 
cgit v1.2.1