libs/gst/dataqueue: Document gst_data_queue_new_full
authorEdward Hervey <bilboed@bilboed.com>
Thu, 1 Oct 2009 09:14:06 +0000 (11:14 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Wed, 13 Oct 2010 10:07:56 +0000 (12:07 +0200)
libs/gst/base/gstdataqueue.c

index a90ab73..fe8ba16 100644 (file)
@@ -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.
  */