dataqueue: Fix gst_data_queue_new() description.
authorJan Schmidt <jan@centricular.com>
Fri, 24 Oct 2014 10:25:54 +0000 (21:25 +1100)
committerJan Schmidt <jan@centricular.com>
Thu, 6 Nov 2014 10:09:09 +0000 (21:09 +1100)
Reword the function docs, which haven't made any sense since
gst_data_queue_new_full() was removed a few years ago.

libs/gst/base/gstdataqueue.c

index 6f61062..2f9c16a 100644 (file)
@@ -217,9 +217,10 @@ gst_data_queue_init (GstDataQueue * queue)
  * @checkdata: a #gpointer that will be passed to the @checkfull, @fullcallback,
  *   and @emptycallback callbacks.
  *
- * 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.
+ * Creates a new #GstDataQueue. If @fullcallback or @emptycallback are supplied, then
+ * the #GstDataQueue will call the respective callback to signal full or empty condition.
+ * If the callbacks are NULL the #GstDataQueue will instead emit 'full' and 'empty'
+ * signals.
  *
  * Returns: a new #GstDataQueue.
  *