dataqueue: clear up documentation of gst_data_queue_new
authorEvan Nemerson <evan@nemerson.com>
Thu, 5 Jun 2014 23:55:15 +0000 (16:55 -0700)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 7 Jun 2014 08:30:14 +0000 (09:30 +0100)
The gpointer argument is passed to all three callbacks, not just one.

https://bugzilla.gnome.org/show_bug.cgi?id=731302

libs/gst/base/gstdataqueue.c

index 0e57794..e34b265 100644 (file)
@@ -214,7 +214,8 @@ gst_data_queue_init (GstDataQueue * queue)
  * 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.
+ * @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