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.
This commit is contained in:
Stefan Kost 2008-03-19 19:56:59 +00:00
parent 2cdcdd43e7
commit 1d98211b08
5 changed files with 44 additions and 6 deletions

View file

@ -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),

View file

@ -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

View file

@ -7,5 +7,3 @@ libgstfreeze_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
noinst_HEADERS = gstfreeze.h
EXTRA_DIST = FAQ

View file

@ -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

View file

@ -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"