From c1bc70300d1d51ec65ce06a072b3a81f15ff29e6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= <tim.muller@collabora.co.uk>
Date: Wed, 16 May 2012 12:40:07 +0100
Subject: [PATCH] docs: fix up video decoder/encoder docs a bit

Makes gtk-doc happy.
---
 gst-libs/gst/video/gstvideodecoder.c | 25 ++++++++++++++-----------
 gst-libs/gst/video/gstvideoencoder.c |  9 ++++++---
 gst-libs/gst/video/gstvideoutils.h   |  1 -
 3 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/gst-libs/gst/video/gstvideodecoder.c b/gst-libs/gst/video/gstvideodecoder.c
index 0778ca779e..8730a3e3d0 100644
--- a/gst-libs/gst/video/gstvideodecoder.c
+++ b/gst-libs/gst/video/gstvideodecoder.c
@@ -2541,8 +2541,7 @@ no_decide_allocation:
  * gst_video_decoder_alloc_output_buffer:
  * @decoder: a #GstVideoDecoder
  *
- * Helper function that uses @gst_pad_alloc_buffer_and_set_caps()
- * to allocate a buffer to hold a video frame for @decoder's
+ * Helper function that allocates a buffer to hold a video frame for @decoder's
  * current #GstVideoCodecState.
  *
  * Returns: (transfer full): allocated buffer
@@ -2574,12 +2573,11 @@ gst_video_decoder_alloc_output_buffer (GstVideoDecoder * decoder)
  * @decoder: a #GstVideoDecoder
  * @frame: a #GstVideoCodecFrame
  *
- * Helper function that uses @gst_pad_alloc_buffer_and_set_caps()
- * to allocate a buffer to hold a video frame for @decoder's
- * current #GstVideoCodecState.  Subclass should already have configured video state
- * and set src pad caps.
+ * Helper function that allocates a buffer to hold a video frame for @decoder's
+ * current #GstVideoCodecState.  Subclass should already have configured video
+ * state and set src pad caps.
  *
- * Returns: result from pad alloc call
+ * Returns: %GST_FLOW_OK if an output buffer could be allocated
  *
  * Since: 0.10.36
  */
@@ -2775,7 +2773,9 @@ gst_video_decoder_get_estimate_rate (GstVideoDecoder * dec)
  * @min_latency: minimum latency
  * @max_latency: maximum latency
  *
- * Informs baseclass of encoding latency.
+ * Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder
+ * latency is. Will also post a LATENCY message on the bus so the pipeline
+ * can reconfigure its global latency.
  *
  * Since: 0.10.36
  */
@@ -2798,10 +2798,13 @@ gst_video_decoder_set_latency (GstVideoDecoder * decoder,
 /**
  * gst_video_decoder_get_latency:
  * @decoder: a #GstVideoDecoder
- * @min_latency: (out) (allow-none): the configured minimum latency
- * @max_latency: (out) (allow-none): the configured maximum latency
+ * @min_latency: (out) (allow-none): address of variable in which to store the
+ *     configured minimum latency, or %NULL
+ * @max_latency: (out) (allow-none): address of variable in which to store the
+ *     configured mximum latency, or %NULL
  *
- * Returns the configured encoding latency.
+ * Query the configured decoder latency. Results will be returned via
+ * @min_latency and @max_latency.
  *
  * Since: 0.10.36
  */
diff --git a/gst-libs/gst/video/gstvideoencoder.c b/gst-libs/gst/video/gstvideoencoder.c
index 1f05f9d110..88b70c6067 100644
--- a/gst-libs/gst/video/gstvideoencoder.c
+++ b/gst-libs/gst/video/gstvideoencoder.c
@@ -1617,10 +1617,13 @@ gst_video_encoder_set_latency (GstVideoEncoder * encoder,
 /**
  * gst_video_encoder_get_latency:
  * @encoder: a #GstVideoEncoder
- * @min_latency: (out) (allow-none): the configured minimum latency
- * @max_latency: (out) (allow-none): the configured maximum latency
+ * @min_latency: (out) (allow-none): address of variable in which to store the
+ *     configured minimum latency, or %NULL
+ * @max_latency: (out) (allow-none): address of variable in which to store the
+ *     configured maximum latency, or %NULL
  *
- * Returns the configured encoding latency.
+ * Query the configured encoding latency. Results will be returned via
+ * @min_latency and @max_latency.
  *
  * Since: 0.10.36
  */
diff --git a/gst-libs/gst/video/gstvideoutils.h b/gst-libs/gst/video/gstvideoutils.h
index 7495faa6e5..d0d7a2c783 100644
--- a/gst-libs/gst/video/gstvideoutils.h
+++ b/gst-libs/gst/video/gstvideoutils.h
@@ -205,7 +205,6 @@ typedef enum
  * @output_buffer: the output #GstBuffer. Implementations should set this either
  *           directly, or by using the @gst_video_decoder_alloc_output_frame() or
  *           @gst_video_decoder_alloc_output_buffer() methods.
- * @field_index:
  * @n_fields: number of fields in the frame (default 2). Decoders can change
  *       this if the frame contains a different number of fields. 
  * @deadline: Running time when the frame will be used.