From a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Wed, 28 Jan 2009 12:29:42 +0200
Subject: 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.
---
 gst/multifile/gstmultifilesink.c |  5 +----
 gst/multifile/gstmultifilesrc.c  | 21 ++++++++-------------
 2 files changed, 9 insertions(+), 17 deletions(-)

(limited to 'gst/multifile')

diff --git a/gst/multifile/gstmultifilesink.c b/gst/multifile/gstmultifilesink.c
index 583b989c..5edb3cd7 100644
--- a/gst/multifile/gstmultifilesink.c
+++ b/gst/multifile/gstmultifilesink.c
@@ -23,13 +23,9 @@
  */
 /**
  * SECTION:element-multifilesink
- * @short_description: Writes buffers to sequentially-named files
  * @see_also: #GstFileSrc
  *
- * <para>
  * Write incoming data to a series of sequentially-named files.
- * </para>
- *
  */
 
 #ifdef HAVE_CONFIG_H
@@ -154,6 +150,7 @@ gst_multi_file_sink_set_location (GstMultiFileSink * sink,
 
   return TRUE;
 }
+
 static void
 gst_multi_file_sink_set_property (GObject * object, guint prop_id,
     const GValue * value, GParamSpec * pspec)
diff --git a/gst/multifile/gstmultifilesrc.c b/gst/multifile/gstmultifilesrc.c
index ee39c565..f6b55ac6 100644
--- a/gst/multifile/gstmultifilesrc.c
+++ b/gst/multifile/gstmultifilesrc.c
@@ -20,29 +20,23 @@
  */
 /**
  * SECTION:element-multifilesrc
- * @short_description: Read buffers from sequentially-named files
  * @see_also: #GstFileSrc
  *
- * <refsect2>
- * <para>
  * Reads buffers from sequentially named files. If used together with an image
- * decoder, one needs to use the GstMultiFileSrc::caps property or a capsfilter
+ * decoder, one needs to use the #GstMultiFileSrc:caps property or a capsfilter
  * to force to caps containing a framerate. Otherwise image decoders send EOS
  * after the first picture.
- * </para>
+ *
+ * File names are created by replacing "%%d" with the index using printf().
+ *
+ * <refsect2>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch multifilesrc location="img.%04d.png" index=0 caps="image/png,framerate=\(fraction\)12/1" ! \
  *     pngdec ! ffmpegcolorspace ! theoraenc ! oggmux ! \
  *     filesink location="images.ogg"
- * </programlisting>
- * This pipeline creates a video file "images.ogg" by joining multiple PNG
+ * ]| This pipeline creates a video file "images.ogg" by joining multiple PNG
  * files named img.0000.png, img.0001.png, etc.
- * </para>
- * <para>
- * File names are created by replacing "%%d" with the index using printf().
- * </para>
  * </refsect2>
 */
 
@@ -232,6 +226,7 @@ gst_multi_file_src_set_location (GstMultiFileSrc * src, const gchar * location)
 
   return TRUE;
 }
+
 static void
 gst_multi_file_src_set_property (GObject * object, guint prop_id,
     const GValue * value, GParamSpec * pspec)
-- 
cgit