From 2aa5ce3111f28f30498c223eb2e8996bfe6e61c3 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sourceforge.net>
Date: Tue, 3 Jul 2007 09:18:22 +0000
Subject: Also document AMR-WB elements.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* ext/amrwb/gstamrwbdec.c:
* ext/amrwb/gstamrwbenc.c:
* ext/amrwb/gstamrwbparse.c:
Also document AMR-WB elements.
---
 ext/amrwb/gstamrwbdec.c   | 17 +++++++++++++++--
 ext/amrwb/gstamrwbenc.c   | 20 ++++++++++++++++++++
 ext/amrwb/gstamrwbparse.c | 17 +++++++++++++++++
 3 files changed, 52 insertions(+), 2 deletions(-)

(limited to 'ext')

diff --git a/ext/amrwb/gstamrwbdec.c b/ext/amrwb/gstamrwbdec.c
index 57de2c7a..9324fad5 100644
--- a/ext/amrwb/gstamrwbdec.c
+++ b/ext/amrwb/gstamrwbdec.c
@@ -17,9 +17,22 @@
  * Boston, MA 02111-1307, USA.
  */
 
-/*
- * library can be found at http://www.penguin.cz/~utx/amr
+/**
+ * SECTION:element-amrwbdec
+ * @see_also: #GstAmrwbEnc, #GstAmrwbParse
+ *
+ * <refsect2>
+ * <para>
+ * This is an AMR wideband decoder based on the 
+ * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
  * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink
+ * </programlisting>
+ * </para>
+ * </refsect2>
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/amrwb/gstamrwbenc.c b/ext/amrwb/gstamrwbenc.c
index 52f303cd..2e342d30 100644
--- a/ext/amrwb/gstamrwbenc.c
+++ b/ext/amrwb/gstamrwbenc.c
@@ -17,6 +17,26 @@
  * Boston, MA 02111-1307, USA.
  */
 
+ /**
+ * SECTION:element-amrwbenc
+ * @see_also: #GstAmrwbDec, #GstAmrwbParse
+ *
+ * <refsect2>
+ * <para>
+ * This is an AMR wideband encoder based on the 
+ * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=abc.wav ! wavparse ! audioresample ! audioconvert ! amrwbenc ! filesink location=abc.amr
+ * </programlisting>
+ * </para>
+ * Please not that the above stream misses the header, that is needed to play
+ * the stream.
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/ext/amrwb/gstamrwbparse.c b/ext/amrwb/gstamrwbparse.c
index d5afc6df..2054fc25 100644
--- a/ext/amrwb/gstamrwbparse.c
+++ b/ext/amrwb/gstamrwbparse.c
@@ -17,6 +17,23 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-amrwbparse
+ * @see_also: #GstAmrwbDec, #GstAmrwbEnc
+ *
+ * <refsect2>
+ * <para>
+ * This is an AMR wideband parser.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
-- 
cgit v1.2.1