mpg123: added gtkdoc section
authorCarlos Rafael Giani <dv@pseudoterminal.org>
Tue, 23 Oct 2012 22:36:42 +0000 (00:36 +0200)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 24 Oct 2012 12:43:23 +0000 (13:43 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=686595

ext/mpg123/gstmpg123audiodec.c

index 5052eab..16bcfce 100644 (file)
  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/**
+ * SECTION: element-mpg123audiodec
+ * @see_also: lamemp3enc, mad
+ *
+ * Audio decoder for MPEG-1 layer 1/2/3 audio data.
+ *
+ * <refsect2>
+ * <title>Example pipelines</title>
+ * |[
+ * gst-launch filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! autoaudiosink
+ * ]| Decode and play the mp3 file
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif