From 522f875d31f8dca8becc1ebc000e5b2a088eaa90 Mon Sep 17 00:00:00 2001
From: Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
Date: Thu, 26 Jun 2008 15:52:40 +0000
Subject: [MOVED FROM BAD] Add documentation for YUV4MPEG2 encoder element.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* gst/y4m/gsty4mencode.c:
Add documentation for YUV4MPEG2 encoder element.
---
 gst/y4m/gsty4mencode.c | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'gst/y4m')

diff --git a/gst/y4m/gsty4mencode.c b/gst/y4m/gsty4mencode.c
index dc432f8d..dc218643 100644
--- a/gst/y4m/gsty4mencode.c
+++ b/gst/y4m/gsty4mencode.c
@@ -1,6 +1,6 @@
 /* GStreamer
  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
- * Copyright (C) <2006> Mark Nauwelaerts <mnauw@skynet.be>
+ * Copyright (C) <2006> Mark Nauwelaerts <mnauw@users.sourceforge.net>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -17,6 +17,25 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-y4menc
+ *
+ * <refsect2>
+ * <para>
+ * Creates a YU4MPEG2 raw video stream as defined by the mjpegtools project.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * (write everything in one line, without the backslash characters)
+ * <programlisting>
+ * gst-launch-0.10 videotestsrc num-buffers=250 \
+ * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \
+ * ! y4menc ! filesink location=test.yuv
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ *
+ */
 
 /* see mjpegtools/yuv4mpeg.h for yuv4mpeg format */
 
-- 
cgit