From d9c57a236de30b415130fc91d8508e8b3c8bb36d Mon Sep 17 00:00:00 2001
From: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
Date: Mon, 2 Apr 2012 12:52:54 +0200
Subject: [PATCH] Fix a few documentation issues.

---
 docs/reference/libs/libs-docs.xml.in            |  4 ++
 docs/reference/libs/libs-sections.txt           | 66 +++++++++++++++++++++++++
 docs/reference/plugins/plugins-docs.xml.in      |  1 +
 docs/reference/plugins/plugins-sections.txt     | 14 ++++++
 docs/reference/plugins/plugins.types            |  3 +-
 gst-libs/gst/vaapi/gstvaapiimage.c              |  1 -
 gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c | 12 +++--
 gst/vaapi/gstvaapipostproc.c                    |  4 +-
 8 files changed, 96 insertions(+), 9 deletions(-)

diff --git a/docs/reference/libs/libs-docs.xml.in b/docs/reference/libs/libs-docs.xml.in
index 97e1961..e432966 100644
--- a/docs/reference/libs/libs-docs.xml.in
+++ b/docs/reference/libs/libs-docs.xml.in
@@ -30,6 +30,10 @@
     <xi:include href="xml/gstvaapivideobuffer.xml"/>
     <xi:include href="xml/gstvaapicontext.xml"/>
     <xi:include href="xml/gstvaapidecoder.xml"/>
+    <xi:include href="xml/gstvaapidecoder_mpeg2.xml"/>
+    <xi:include href="xml/gstvaapidecoder_mpeg4.xml"/>
+    <xi:include href="xml/gstvaapidecoder_h264.xml"/>
+    <xi:include href="xml/gstvaapidecoder_vc1.xml"/>
     <xi:include href="xml/gstvaapidecoder_ffmpeg.xml"/>
     <xi:include href="xml/gstvaapisurfaceproxy.xml"/>
     <xi:include href="xml/gstvaapivideosink.xml"/>
diff --git a/docs/reference/libs/libs-sections.txt b/docs/reference/libs/libs-sections.txt
index d60213a..afcb793 100644
--- a/docs/reference/libs/libs-sections.txt
+++ b/docs/reference/libs/libs-sections.txt
@@ -489,6 +489,70 @@ GST_VAAPI_DECODER_FFMPEG_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>gstvaapidecoder_mpeg2</FILE>
+<TITLE>GstVaapiDecoderMpeg2</TITLE>
+GstVaapiDecoderMpeg2
+GstVaapiDecoderMpeg2Class
+gst_vaapi_decoder_mpeg2_new
+<SUBSECTION Standard>
+GST_VAAPI_DECODER_MPEG2
+GST_VAAPI_IS_DECODER_MPEG2
+GST_VAAPI_TYPE_DECODER_MPEG2
+gst_vaapi_decoder_mpeg2_get_type
+GST_VAAPI_DECODER_MPEG2_CLASS
+GST_VAAPI_IS_DECODER_MPEG2_CLASS
+GST_VAAPI_DECODER_MPEG2_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstvaapidecoder_mpeg4</FILE>
+<TITLE>GstVaapiDecoderMpeg4</TITLE>
+GstVaapiDecoderMpeg4
+GstVaapiDecoderMpeg4Class
+gst_vaapi_decoder_mpeg4_new
+<SUBSECTION Standard>
+GST_VAAPI_DECODER_MPEG4
+GST_VAAPI_IS_DECODER_MPEG4
+GST_VAAPI_TYPE_DECODER_MPEG4
+gst_vaapi_decoder_mpeg4_get_type
+GST_VAAPI_DECODER_MPEG4_CLASS
+GST_VAAPI_IS_DECODER_MPEG4_CLASS
+GST_VAAPI_DECODER_MPEG4_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstvaapidecoder_h264</FILE>
+<TITLE>GstVaapiDecoderH264</TITLE>
+GstVaapiDecoderH264
+GstVaapiDecoderH264Class
+gst_vaapi_decoder_h264_new
+<SUBSECTION Standard>
+GST_VAAPI_DECODER_H264
+GST_VAAPI_IS_DECODER_H264
+GST_VAAPI_TYPE_DECODER_H264
+gst_vaapi_decoder_h264_get_type
+GST_VAAPI_DECODER_H264_CLASS
+GST_VAAPI_IS_DECODER_H264_CLASS
+GST_VAAPI_DECODER_H264_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstvaapidecoder_vc1</FILE>
+<TITLE>GstVaapiDecoderVC1</TITLE>
+GstVaapiDecoderVC1
+GstVaapiDecoderVC1Class
+gst_vaapi_decoder_vc1_new
+<SUBSECTION Standard>
+GST_VAAPI_DECODER_VC1
+GST_VAAPI_IS_DECODER_VC1
+GST_VAAPI_TYPE_DECODER_VC1
+gst_vaapi_decoder_vc1_get_type
+GST_VAAPI_DECODER_VC1_CLASS
+GST_VAAPI_IS_DECODER_VC1_CLASS
+GST_VAAPI_DECODER_VC1_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>gstvaapisurfaceproxy</FILE>
 <TITLE>GstVaapiSurfaceProxy</TITLE>
 GstVaapiSurfaceProxy
@@ -501,6 +565,8 @@ gst_vaapi_surface_proxy_get_surface_id
 gst_vaapi_surface_proxy_set_surface
 gst_vaapi_surface_proxy_get_timestamp
 gst_vaapi_surface_proxy_set_timestamp
+gst_vaapi_surface_proxy_get_interlaced
+gst_vaapi_surface_proxy_set_interlaced
 gst_vaapi_surface_proxy_get_tff
 gst_vaapi_surface_proxy_set_tff
 <SUBSECTION Standard>
diff --git a/docs/reference/plugins/plugins-docs.xml.in b/docs/reference/plugins/plugins-docs.xml.in
index 550355e..3532a55 100644
--- a/docs/reference/plugins/plugins-docs.xml.in
+++ b/docs/reference/plugins/plugins-docs.xml.in
@@ -12,6 +12,7 @@
   <chapter>
     <title>gst-plugins-vaapi Plugins</title>
     <xi:include href="xml/gstvaapidecode.xml"/>
+    <xi:include href="xml/gstvaapipostproc.xml"/>
     <xi:include href="xml/gstvaapidownload.xml"/>
     <xi:include href="xml/gstvaapiupload.xml"/>
     <xi:include href="xml/gstvaapisink.xml"/>
diff --git a/docs/reference/plugins/plugins-sections.txt b/docs/reference/plugins/plugins-sections.txt
index 48cd444..58f3fe8 100644
--- a/docs/reference/plugins/plugins-sections.txt
+++ b/docs/reference/plugins/plugins-sections.txt
@@ -27,6 +27,20 @@ GST_VAAPIDECODE_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>gstvaapipostproc</FILE>
+<TITLE>GstVaapiPostproc</TITLE>
+GstVaapiPostproc
+<SUBSECTION Standard>
+GST_VAAPIPOSTPROC
+GST_IS_VAAPIPOSTPROC
+GST_TYPE_VAAPIPOSTPROC
+gst_vaapipostproc_get_type
+GST_VAAPIPOSTPROC_CLASS
+GST_IS_VAAPIPOSTPROC_CLASS
+GST_VAAPIPOSTPROC_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>gstvaapiupload</FILE>
 <TITLE>GstVaapiUpload</TITLE>
 GstVaapiUpload
diff --git a/docs/reference/plugins/plugins.types b/docs/reference/plugins/plugins.types
index 72cb6a4..4117580 100644
--- a/docs/reference/plugins/plugins.types
+++ b/docs/reference/plugins/plugins.types
@@ -1,4 +1,5 @@
-gst_vaapisink_get_type
 gst_vaapidecode_get_type
 gst_vaapidownload_get_type
+gst_vaapipostproc_get_type
+gst_vaapisink_get_type
 gst_vaapiupload_get_type
diff --git a/gst-libs/gst/vaapi/gstvaapiimage.c b/gst-libs/gst/vaapi/gstvaapiimage.c
index 8348b2c..717d952 100644
--- a/gst-libs/gst/vaapi/gstvaapiimage.c
+++ b/gst-libs/gst/vaapi/gstvaapiimage.c
@@ -1189,7 +1189,6 @@ gst_vaapi_image_get_buffer(
  * gst_vaapi_image_get_raw:
  * @image: a #GstVaapiImage
  * @dst_image: a #GstVaapiImageRaw
- * @buffer: a #GstBuffer
  * @rect: a #GstVaapiRectangle expressing a region, or %NULL for the
  *   whole image
  *
diff --git a/gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c b/gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c
index 646a82f..106b8ea 100644
--- a/gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c
+++ b/gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c
@@ -76,13 +76,15 @@ gst_vaapi_video_converter_glx_iface_init (GstSurfaceConverterInterface *iface) {
 
 /**
  * gst_vaapi_video_converter_glx_new:
- * @
+ * @surface: the #GstSurfaceBuffer
+ * @type: type of the target buffer (must be "opengl")
+ * @dest: target of the conversion (must be GL texture id)
  *
- * Creates an empty #GstBuffer. The caller is responsible for completing
- * the initialization of the buffer with the gst_vaapi_video_converter_glx_set_*()
- * functions.
+ * Creates an empty #GstBuffer. The caller is responsible for
+ * completing the initialization of the buffer with the
+ * gst_vaapi_video_converter_glx_set_*() functions.
  *
- * Return value: the newly allocated #GstBuffer, or %NULL or error
+ * Return value: the newly allocated #GstBuffer, or %NULL on error
  */
 GstSurfaceConverter *
 gst_vaapi_video_converter_glx_new(GstSurfaceBuffer *surface, const gchar *type,
diff --git a/gst/vaapi/gstvaapipostproc.c b/gst/vaapi/gstvaapipostproc.c
index 31a46e2..ca9400a 100644
--- a/gst/vaapi/gstvaapipostproc.c
+++ b/gst/vaapi/gstvaapipostproc.c
@@ -629,7 +629,7 @@ gst_vaapipostproc_class_init(GstVaapiPostprocClass *klass)
     element_class->change_state = gst_vaapipostproc_change_state;
 
     /**
-     * GstVaapiSink:deinterlace-mode:
+     * GstVaapiPostproc:deinterlace-mode:
      *
      * This selects whether the deinterlacing should always be applied or if
      * they should only be applied on content that has the "interlaced" flag
@@ -646,7 +646,7 @@ gst_vaapipostproc_class_init(GstVaapiPostprocClass *klass)
                            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
     /**
-     * GstVaapiSink:deinterlace-method:
+     * GstVaapiPostproc:deinterlace-method:
      *
      * This selects the deinterlacing method to apply.
      */
-- 
2.7.4