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.

5 files changed, 42 insertions, 1 deletions

diff --git a/ChangeLog b/ChangeLog
index 91fe13f4..9540d167 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-06-26  Mark Nauwelaerts  <mark.nauwelaerts@collabora.co.uk>
+
+	* 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.
+
 2008-06-25  Edward Hervey  <edward.hervey@collabora.co.uk>
 
 	* gst/deinterlace2/tvtime/tomsmocomp/tomsmocompmacros.h:
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 7476ac64..2076f94b 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -138,6 +138,7 @@ EXTRA_HFILES = \
 	$(top_srcdir)/gst/videosignal/gstvideoanalyse.h \
 	$(top_srcdir)/gst/videosignal/gstvideodetect.h \
 	$(top_srcdir)/gst/videosignal/gstvideomark.h \
+	$(top_srcdir)/gst/y4m/gsty4mencode.h \
 	$(top_srcdir)/sys/dvb/gstdvbsrc.h
 
 # Images to copy into HTML directory.
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index b6635826..ade2b13c 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -55,6 +55,7 @@
     <xi:include href="xml/element-videomark.xml" />
     <xi:include href="xml/element-videoparse.xml" />
     <xi:include href="xml/element-wildmidi.xml" />
+    <xi:include href="xml/element-y4menc.xml" />
   </chapter>
 
   <chapter>
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index be47b636..efc25243 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -703,3 +703,15 @@ GST_IS_WILDMIDI_CLASS
 GST_TYPE_WILDMIDI
 </SECTION>
 
+<SECTION>
+<FILE>element-y4menc</FILE>
+<TITLE>y4menc</TITLE>
+GstY4mEncode
+<SUBSECTION Standard>
+GstY4mEncodeClass
+GST_Y4M_ENCODE
+GST_Y4M_ENCODE_CLASS
+GST_IS_Y4M_ENCODE
+GST_IS_Y4M_ENCODE_CLASS
+GST_TYPE_Y4M_ENCODE
+</SECTION>
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 */