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.

1 files changed, 18 insertions, 13 deletions

diff --git a/gst/id3demux/gstid3demux.c b/gst/id3demux/gstid3demux.c
index 14713756..3e7a2b73 100644
--- a/gst/id3demux/gstid3demux.c
+++ b/gst/id3demux/gstid3demux.c
@@ -21,23 +21,28 @@
 
 /**
  * SECTION:element-id3demux
- * @short_description: reads tag information from ID3v1 and ID3v2 (<= 2.4.0) data blocks and outputs them as GStreamer tag messages and events.
+ *
+ * id3demux accepts data streams with either (or both) ID3v2 regions at the
+ * start, or ID3v1 at the end. 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. 
+ *
+ * The element is only able to read ID3v1 tags from a seekable stream, because
+ * they are at the end of the stream. That is, when get_range mode is supported
+ * by the upstream elements. If get_range operation is available, id3demux makes
+ * it available downstream. This means that elements which require get_range
+ * mode, such as wavparse, can operate on files containing ID3 tag information.
+ *
+ * This id3demux element replaced an older element with the same name which
+ * relied on libid3tag from the MAD project.
  *
  * <refsect2>
- * <para>
- * id3demux accepts data streams with either (or both) ID3v2 regions at the start, or ID3v1 at the end. 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><para>
- * The element is only able to read ID3v1 tags from a seekable stream, because they are at the end of the stream. That is, when get_range mode is supported by the upstream elements. If get_range operation is available, id3demux makes it available downstream. This means that elements which require get_range mode, such as wavparse, can operate on files containing ID3 tag information.
- * </para>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch filesrc location=file.mp3 ! id3demux ! fakesink -t
- * </programlisting>
- * This pipeline should read any available ID3 tag information and output it. The contents of the file inside the ID3 tag regions should be detected, and the appropriate mime type set on buffers produced from id3demux.
- * </para><para>
- * This id3demux element replaced an older element with the same name which relied on libid3tag from the MAD project.
- * </para>
+ * ]| This pipeline should read any available ID3 tag information and output it.
+ * The contents of the file inside the ID3 tag regions should be detected, and
+ * the appropriate mime type set on buffers produced from id3demux.
  * </refsect2>
  */
 #ifdef HAVE_CONFIG_H