From 9cf73bdd8f18505269fa4b6d1d80127945e735b1 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Wed, 28 Jan 2009 17:46:06 +0200
Subject: Update and add documentation for plugins with deps (ext).

Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
---
 ext/taglib/gstapev2mux.cc | 25 ++++++++++---------------
 ext/taglib/gstid3v2mux.cc | 25 ++++++++++---------------
 2 files changed, 20 insertions(+), 30 deletions(-)

(limited to 'ext/taglib')

diff --git a/ext/taglib/gstapev2mux.cc b/ext/taglib/gstapev2mux.cc
index b7a61bff..6857e253 100644
--- a/ext/taglib/gstapev2mux.cc
+++ b/ext/taglib/gstapev2mux.cc
@@ -23,28 +23,23 @@
  * SECTION:element-apev2mux
  * @see_also: #GstTagSetter
  *
- * <refsect2>
- * <para>
  * This element adds APEv2 tags to the beginning of a stream using the taglib
  * library.
- * </para>
- * <para>
+ *
  * Applications can set the tags to write using the #GstTagSetter interface.
  * Tags sent by upstream elements will be picked up automatically (and merged
  * according to the merge mode set via the tag setter interface).
- * </para>
- * <para>
- * Here is a simple pipeline that transcodes a file from Ogg/Vorbis to mp3
- * format with an APEv2 that contains the same as the the Ogg/Vorbis file:
- * <programlisting>
+ *
+ * <refsect2>
+ * <title>Example pipelines</title>
+ * |[
  * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! lame ! apev2mux ! filesink location=foo.mp3
- * </programlisting>
- * Make sure the Ogg/Vorbis file actually has comments to preserve.
- * You can verify the tags were written using:
- * <programlisting>
+ * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with an
+ * APEv2 that contains the same as the the Ogg/Vorbis file. Make sure the
+ * Ogg/Vorbis file actually has comments to preserve.
+ * |[
  * gst-launch -m filesrc location=foo.mp3 ! apedemux ! fakesink silent=TRUE 2&gt; /dev/null | grep taglist
- * </programlisting>
- * </para>
+ * ]| Verify that tags have been written.
  * </refsect2>
  */
 
diff --git a/ext/taglib/gstid3v2mux.cc b/ext/taglib/gstid3v2mux.cc
index cf176279..fd15836e 100644
--- a/ext/taglib/gstid3v2mux.cc
+++ b/ext/taglib/gstid3v2mux.cc
@@ -22,30 +22,25 @@
  * SECTION:element-id3v2mux
  * @see_also: #GstID3Demux, #GstTagSetter
  *
- * <refsect2>
- * <para>
  * This element adds ID3v2 tags to the beginning of a stream using the taglib
  * library. More precisely, the tags written are ID3 version 2.4.0 tags (which
  * means in practice that some hardware players or outdated programs might not
  * be able to read them properly).
- * </para>
- * <para>
+ *
  * Applications can set the tags to write using the #GstTagSetter interface.
  * Tags sent by upstream elements will be picked up automatically (and merged
  * according to the merge mode set via the tag setter interface).
- * </para>
- * <para>
- * Here is a simple pipeline that transcodes a file from Ogg/Vorbis to mp3
- * format with an ID3v2 that contains the same as the the Ogg/Vorbis file:
- * <programlisting>
+ *
+ * <refsect2>
+ * <title>Example pipelines</title>
+ * |[
  * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! lame ! id3v2mux ! filesink location=foo.mp3
- * </programlisting>
- * Make sure the Ogg/Vorbis file actually has comments to preserve.
- * You can verify the tags were written using:
- * <programlisting>
+ * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with an
+ * ID3v2 that contains the same as the the Ogg/Vorbis file. Make sure the
+ * Ogg/Vorbis file actually has comments to preserve.
+ * |[
  * gst-launch -m filesrc location=foo.mp3 ! id3demux ! fakesink silent=TRUE 2&gt; /dev/null | grep taglist
- * </programlisting>
- * </para>
+ * ]| Verify that tags have been written.
  * </refsect2>
  */
 
-- 
cgit