summaryrefslogtreecommitdiffstats
path: root/gst/icydemux
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 12:29:42 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 12:32:59 +0200
commita99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch)
tree4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/icydemux
parent00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff)
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/icydemux')
-rw-r--r--gst/icydemux/gsticydemux.c14
1 files changed, 4 insertions, 10 deletions
diff --git a/gst/icydemux/gsticydemux.c b/gst/icydemux/gsticydemux.c
index 8ea4d1a5..234f3f80 100644
--- a/gst/icydemux/gsticydemux.c
+++ b/gst/icydemux/gsticydemux.c
@@ -21,27 +21,21 @@
/**
* SECTION:element-icydemux
- * @short_description: reads tag information from an Icy (Icecast/Shoutcast)
- * stream, outputting them as tag messages, and forwarding the enclosed data.
*
- * <refsect2>
- * <para>
* icydemux accepts data streams with ICY metadata at known intervals, as
* transmitted from an upstream element (usually read as response headers from
* an HTTP stream). The mime type of the data between the tag blocks is
* detected using typefind functions, and the appropriate output mime type set
* on outgoing buffers.
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch souphttpsrc location=http://some.server/ iradio-mode=true ! icydemux ! fakesink -t
- * </programlisting>
- * This pipeline should read any available ICY tag information and output it.
+ * ]| This pipeline should read any available ICY tag information and output it.
* The contents of the stream should be detected, and the appropriate mime
* type set on buffers produced from icydemux. (Using gnomevfssrc, neonhttpsrc
* or giosrc instead of souphttpsrc should also work.)
- * </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H