summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2010-12-03 18:11:38 +0100
committerMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2010-12-03 18:23:17 +0100
commit8f0e2346c7aef59c41df80d58a8af8d37e38e763 (patch)
tree6c8b85d01c87203c4be844e16965dfa550e45247
parentfa0dea3fdc8b94739a95cd3fc9e62762dddf3835 (diff)
downloadgstreamer-plugins-bad-8f0e2346c7aef59c41df80d58a8af8d37e38e763.tar.gz
mpegaudioparse: add to documentation
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-docs.sgml1
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-sections.txt14
-rw-r--r--gst/audioparsers/gstmpegaudioparse.c13
4 files changed, 21 insertions, 8 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index b9f3af4b7..ff940df71 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -141,6 +141,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/audioparsers/gstamrparse.h \
$(top_srcdir)/gst/audioparsers/gstflacparse.h \
$(top_srcdir)/gst/audioparsers/gstdcaparse.h \
+ $(top_srcdir)/gst/audioparsers/gstmpegaudioparse.h \
$(top_srcdir)/gst/autoconvert/gstautoconvert.h \
$(top_srcdir)/gst/camerabin/gstcamerabin.h \
$(top_srcdir)/gst/coloreffects/gstcoloreffects.h \
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index 9550b6f63..575afc1b1 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -86,6 +86,7 @@
<xi:include href="xml/element-mimdec.xml" />
<xi:include href="xml/element-mirror.xml" />
<xi:include href="xml/element-modplug.xml" />
+ <xi:include href="xml/element-mpegaudioparse.xml" />
<xi:include href="xml/element-mpeg2enc.xml" />
<xi:include href="xml/element-mplex.xml" />
<xi:include href="xml/element-mythtvsrc.xml" />
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index 188f6b2c7..fdfb78136 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1071,6 +1071,20 @@ gst_modplug_get_type
</SECTION>
<SECTION>
+<FILE>element-mpegaudioparse</FILE>
+<TITLE>mpegaudioparse</TITLE>
+GstMpegAudioParse
+<SUBSECTION Standard>
+GstMpegAudioParseClass
+GST_MPEG_AUDIO_PARSE
+GST_MPEG_AUDIO_PARSE_CLASS
+GST_IS_MPEG_AUDIO_PARSE
+GST_IS_MPEG_AUDIO_PARSE_CLASS
+GST_TYPE_MPEG_AUDIO_PARSE
+gst_mpeg_audio_parse_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-mpeg2enc</FILE>
<TITLE>mpeg2enc</TITLE>
GstMpeg2enc
diff --git a/gst/audioparsers/gstmpegaudioparse.c b/gst/audioparsers/gstmpegaudioparse.c
index ce6384dd8..889efec1f 100644
--- a/gst/audioparsers/gstmpegaudioparse.c
+++ b/gst/audioparsers/gstmpegaudioparse.c
@@ -24,16 +24,13 @@
* @short_description: MPEG audio parser
* @see_also: #GstAmrParse, #GstAACParse
*
- * <refsect2>
- * <para>
* Parses and frames mpeg1 audio streams. Provides seeking.
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
- * gst-launch filesrc location=test.mp3 ! mp3parse ! mad ! autoaudiosink
- * </programlisting>
- * </para>
+ * |[
+ * gst-launch filesrc location=test.mp3 ! mpegaudioparse ! mad ! autoaudiosink
+ * ]|
* </refsect2>
*/