From 22dcc68a62f9edf0554e5885b59f716131845aba Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Tue, 27 Apr 2010 11:02:15 +0300
Subject: [PATCH] docs: add docs for mp3parse

---
 docs/plugins/Makefile.am                         |  1 +
 docs/plugins/gst-plugins-ugly-plugins-docs.sgml  |  1 +
 .../gst-plugins-ugly-plugins-sections.txt        | 16 ++++++++++++++++
 gst/mpegaudioparse/gstmpegaudioparse.c           | 14 ++++++++++++++
 4 files changed, 32 insertions(+)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 041e00413c..23a48adfe8 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -95,6 +95,7 @@ EXTRA_HFILES = \
 	$(top_srcdir)/ext/twolame/gsttwolame.h \
 	$(top_srcdir)/ext/x264/gstx264enc.h \
 	$(top_srcdir)/gst/asfdemux/gstrtspwms.h \
+	$(top_srcdir)/gst/mpegaudioparse/gstmpegaudioparse.h \
 	$(top_srcdir)/gst/mpegaudioparse/gstxingmux.h \
 	$(top_srcdir)/gst/realmedia/rademux.h \
 	$(top_srcdir)/gst/realmedia/rdtmanager.h \
diff --git a/docs/plugins/gst-plugins-ugly-plugins-docs.sgml b/docs/plugins/gst-plugins-ugly-plugins-docs.sgml
index 6ed378017f..bc4a40c5c5 100644
--- a/docs/plugins/gst-plugins-ugly-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-ugly-plugins-docs.sgml
@@ -25,6 +25,7 @@
     <xi:include href="xml/element-lame.xml" />
     <xi:include href="xml/element-lamemp3enc.xml" />
     <xi:include href="xml/element-mad.xml" />
+    <xi:include href="xml/element-mp3parse.xml" />
     <xi:include href="xml/element-rademux.xml" />
     <xi:include href="xml/element-rdtmanager.xml" />
     <xi:include href="xml/element-rtspreal.xml" />
diff --git a/docs/plugins/gst-plugins-ugly-plugins-sections.txt b/docs/plugins/gst-plugins-ugly-plugins-sections.txt
index 6352436fc9..f3db9dd5d9 100644
--- a/docs/plugins/gst-plugins-ugly-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-ugly-plugins-sections.txt
@@ -110,6 +110,22 @@ GST_TYPE_MAD
 gst_mad_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-mp3parse</FILE>
+<TITLE>mp3parse</TITLE>
+GstMPEGAudioParse
+<SUBSECTION Standard>
+GstMPEGAudioParseClass
+MPEGAudioPendingAccurateSeek
+MPEGAudioSeekEntry
+GST_MP3PARSE
+GST_MP3PARSE_CLASS
+GST_IS_MP3PARSE
+GST_IS_MP3PARSE_CLASS
+GST_TYPE_MP3PARSE
+gst_mp3parse_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-rademux</FILE>
 <TITLE>rademux</TITLE>
diff --git a/gst/mpegaudioparse/gstmpegaudioparse.c b/gst/mpegaudioparse/gstmpegaudioparse.c
index 42e7ac5527..4d81914dab 100644
--- a/gst/mpegaudioparse/gstmpegaudioparse.c
+++ b/gst/mpegaudioparse/gstmpegaudioparse.c
@@ -18,6 +18,20 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-mp3parse
+ *
+ * Parses and frames mpeg1 audio streams. Provides seeking.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch filesrc location=test.mp3 ! mp3parse ! autoaudiosink
+ * ]|
+ * </refsect2>
+ */
+
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif