From 6335307b9739beb568f986bfc8a4c1e1fb2b8e31 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Thu, 29 Jan 2009 10:10:08 +0200
Subject: Update and add documentation for platform specific plugins (sys).

Link to properties. Correct titles for examples. Fix examples.
---
 sys/oss/gstossmixerelement.c | 10 ++++------
 sys/oss/gstosssink.c         | 24 ++++++++----------------
 sys/oss/gstosssrc.c          | 14 +++++---------
 3 files changed, 17 insertions(+), 31 deletions(-)

(limited to 'sys/oss')

diff --git a/sys/oss/gstossmixerelement.c b/sys/oss/gstossmixerelement.c
index 3ca3abb5..0988e367 100644
--- a/sys/oss/gstossmixerelement.c
+++ b/sys/oss/gstossmixerelement.c
@@ -19,15 +19,13 @@
 
 /**
  * SECTION:element-ossmixer
- * @short_description: element to control sound input and output levels with OSS
  *
- * <refsect2>
- * <para>
  * This element lets you adjust sound input and output levels with the
- * Open Sound System (OSS). It supports the GstMixer interface, which can be
+ * Open Sound System (OSS). It supports the #GstMixer interface, which can be
  * used to obtain a list of available mixer tracks. Set the mixer element to
- * READY state before using the GstMixer interface on it.
- * </para>
+ * READY state before using the #GstMixer interface on it.
+ *
+ * <refsect2>
  * <title>Example pipelines</title>
  * <para>
  * ossmixer can't be used in a sensible way in gst-launch.
diff --git a/sys/oss/gstosssink.c b/sys/oss/gstosssink.c
index 43fc167a..c508140c 100644
--- a/sys/oss/gstosssink.c
+++ b/sys/oss/gstosssink.c
@@ -22,32 +22,23 @@
 
 /**
  * SECTION:element-osssink
- * @short_description: output sound using OSS
  *
- * <refsect2>
- * <para>
  * This element lets you output sound using the Open Sound System (OSS).
- * </para>
- * <para>
+ *
  * Note that you should almost always use generic audio conversion elements
  * like audioconvert and audioresample in front of an audiosink to make sure
  * your pipeline works under all circumstances (those conversion elements will
  * act in passthrough-mode if no conversion is necessary).
- * </para>
+ *
+ * <refsect2>
  * <title>Example pipelines</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.1 ! osssink
- * </programlisting>
- * will output a sine wave (continuous beep sound) to your sound card (with
+ * ]| will output a sine wave (continuous beep sound) to your sound card (with
  * a very low volume as precaution).
- * </para>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch -v filesrc location=music.ogg ! decodebin ! audioconvert ! audioresample ! osssink
- * </programlisting>
- * will play an Ogg/Vorbis audio file and output it using the Open Sound System.
- * </para>
+ * ]| will play an Ogg/Vorbis audio file and output it using the Open Sound System.
  * </refsect2>
  */
 
@@ -197,6 +188,7 @@ gst_oss_sink_base_init (gpointer g_class)
   gst_element_class_add_pad_template (element_class,
       gst_static_pad_template_get (&osssink_sink_factory));
 }
+
 static void
 gst_oss_sink_class_init (GstOssSinkClass * klass)
 {
diff --git a/sys/oss/gstosssrc.c b/sys/oss/gstosssrc.c
index 64b3736e..026ba2a4 100644
--- a/sys/oss/gstosssrc.c
+++ b/sys/oss/gstosssrc.c
@@ -22,21 +22,16 @@
 
 /**
  * SECTION:element-osssrc
- * @short_description: record sound from your sound card using OSS
  *
- * <refsect2>
- * <para>
  * This element lets you record sound using the Open Sound System (OSS).
- * </para>
+ *
+ * <refsect2>
  * <title>Example pipelines</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch -v osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=mymusic.ogg
- * </programlisting>
- * will record sound from your sound card using OSS and encode it to an
+ * ]| will record sound from your sound card using OSS and encode it to an
  * Ogg/Vorbis file (this will only work if your mixer settings are right
  * and the right inputs enabled etc.)
- * </para>
  * </refsect2>
  */
 
@@ -147,6 +142,7 @@ gst_oss_src_base_init (gpointer g_class)
   gst_element_class_add_pad_template (element_class,
       gst_static_pad_template_get (&osssrc_src_factory));
 }
+
 static void
 gst_oss_src_class_init (GstOssSrcClass * klass)
 {
-- 
cgit