From 1d98211b0860bdfc74ed06e8720e10061fb3b2f6 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sourceforge.net>
Date: Wed, 19 Mar 2008 19:56:59 +0000
Subject: gst/freeze/: Add example to source code documentation blob and remove
 the 3 line

Original commit message from CVS:
* gst/freeze/FAQ:
* gst/freeze/Makefile.am:
* gst/freeze/gstfreeze.c:
Add example to source code documentation blob and remove the 3 line
FAQ.
* gst/interleave/interleave.c:
Add a source code documentation blob.
---
 ChangeLog                   | 11 +++++++++++
 gst/freeze/FAQ              |  4 ----
 gst/freeze/Makefile.am      |  2 --
 gst/freeze/gstfreeze.c      | 16 ++++++++++++++++
 gst/interleave/interleave.c | 17 +++++++++++++++++
 5 files changed, 44 insertions(+), 6 deletions(-)
 delete mode 100644 gst/freeze/FAQ

diff --git a/ChangeLog b/ChangeLog
index dd48a716..5f4c55a5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2008-03-19  Stefan Kost  <ensonic@users.sf.net>
+
+	* gst/freeze/FAQ:
+	* gst/freeze/Makefile.am:
+	* gst/freeze/gstfreeze.c:
+	  Add example to source code documentation blob and remove the 3 line
+	  FAQ.
+
+	* gst/interleave/interleave.c:
+	  Add a source code documentation blob.
+
 2008-03-19  Sebastian Dröge  <slomo@circular-chaos.org>
 
 	* ext/ofa/gstofa.c: (create_fingerprint), (gst_ofa_event),
diff --git a/gst/freeze/FAQ b/gst/freeze/FAQ
deleted file mode 100644
index 2c7e7154..00000000
--- a/gst/freeze/FAQ
+++ /dev/null
@@ -1,4 +0,0 @@
-example usage
-
-gst-launch-0.10 --gst-debug=*freeze*:5 -mvt filesrc location=gnome-home.png blocksize=4135 !  pngdec ! freeze ! ffmpegcolorspace ! xvimagesink
-
diff --git a/gst/freeze/Makefile.am b/gst/freeze/Makefile.am
index 66c37a67..525e476e 100644
--- a/gst/freeze/Makefile.am
+++ b/gst/freeze/Makefile.am
@@ -7,5 +7,3 @@ libgstfreeze_la_LDFLAGS	= $(GST_PLUGIN_LDFLAGS)
 
 noinst_HEADERS		= gstfreeze.h
 
-EXTRA_DIST		= FAQ
-
diff --git a/gst/freeze/gstfreeze.c b/gst/freeze/gstfreeze.c
index 5b6a688d..23c6efdf 100644
--- a/gst/freeze/gstfreeze.c
+++ b/gst/freeze/gstfreeze.c
@@ -15,6 +15,22 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  */
 
+/**
+ * SECTION:element-freeze
+ *
+ * <refsect2>
+ * <para>
+ * Makes a stream from buffers of data.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch-0.10 --gst-debug=*freeze*:5 -mvt filesrc location=gnome-home.png blocksize=4135 !  pngdec ! freeze ! ffmpegcolorspace ! xvimagesink 
+ * </programlisting>
+ * Produces a video stream from one picture.
+ * </para>
+ * </refsect2>
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/gst/interleave/interleave.c b/gst/interleave/interleave.c
index 0ca2ea6c..bce077d7 100644
--- a/gst/interleave/interleave.c
+++ b/gst/interleave/interleave.c
@@ -22,6 +22,23 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-interleave
+ *
+ * <refsect2>
+ * <para>
+ * Merges separate mono inputs into one interleaved stream.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch-0.10 filesrc location=song.ogg ! decodebin ! audioconvert ! ladspa-gverb name=g ! interleave name=i ! audioconvert ! autoaudiosink g. ! i.
+ * </programlisting>
+ * Apply ladspa gverb to the music and merge separate left/right outputs into a
+ * stereo stream for playback.
+ * </para>
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
-- 
cgit v1.2.1