gst/freeze/: Add example to source code documentation blob and remove the 3 line
authorStefan Kost <ensonic@users.sourceforge.net>
Wed, 19 Mar 2008 19:56:59 +0000 (19:56 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Wed, 19 Mar 2008 19:56:59 +0000 (19:56 +0000)
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.

gst/interleave/interleave.c

index 0ca2ea6..bce077d 100644 (file)
  * 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"