From: Edward Hervey <bilboed@bilboed.com>
Date: Thu, 1 Oct 2009 09:14:06 +0000 (+0200)
Subject: libs/gst/dataqueue: Document gst_data_queue_new_full
X-Git-Tag: RELEASE-0.10.31~37
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=80727c117703507f790a86b0962ab3d915e5a491;p=platform%2Fupstream%2Fgstreamer.git

libs/gst/dataqueue: Document gst_data_queue_new_full
---

diff --git a/libs/gst/base/gstdataqueue.c b/libs/gst/base/gstdataqueue.c
index a90ab73..fe8ba16 100644
--- a/libs/gst/base/gstdataqueue.c
+++ b/libs/gst/base/gstdataqueue.c
@@ -219,11 +219,17 @@ gst_data_queue_new_full (GstDataQueueCheckFullFunction checkfull,
 }
 
 /**
- * gst_data_queue_new:
+ * gst_data_queue_new_full:
  * @checkfull: the callback used to tell if the element considers the queue full
  * or not.
+ * @fullcallback: the callback which will be called when the queue is considered full.
+ * @emptycallback: the callback which will be called when the queue is considered empty.
  * @checkdata: a #gpointer that will be given in the @checkfull callback.
  *
+ * Creates a new #GstDataQueue. The difference with @gst_data_queue_new is that it will
+ * not emit the 'full' and 'empty' signals, but instead calling directly @fullcallback
+ * or @emptycallback.
+ *
  * Returns: a new #GstDataQueue.
  */