plugins/elements/gstmultiqueue.c: Add documentation for the signals to push our core...

Original commit message from CVS:
* plugins/elements/gstmultiqueue.c:
Add documentation for the signals to push our core plugin docs
coverage back up to 100%.

diff --git a/ChangeLog b/ChangeLog
index e6aa0236e9e0144603360b21bae6b2eaf87ddfd1..b7a8fa6788f13bad363b5e7cdbe00d14c5c132d8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-05-09  Jan Schmidt  <jan.schmidt@sun.com>
+
+       * plugins/elements/gstmultiqueue.c:
+       Add documentation for the signals to push our core plugin docs
+       coverage back up to 100%.
+
 2008-05-08  Ole André Vadla Ravnås  <ole.andre.ravnas at tandberg com>
 
        * gst/gstinfo.h (GST_FUNCTION):

diff --git a/common b/common
index ba3dd2882b1611f8115f9664e3b85e1fd956b53d..dbf8f3aeceb6e57de097951a670cd853b4886ad8 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit ba3dd2882b1611f8115f9664e3b85e1fd956b53d
+Subproject commit dbf8f3aeceb6e57de097951a670cd853b4886ad8

diff --git a/plugins/elements/gstmultiqueue.c b/plugins/elements/gstmultiqueue.c
index 29a9d7d81a72e37b0e67b36953dbd1bc1e97d348..78bba70d8a87ecdcdaddeb0f01fa52517c585979 100644 (file)
--- a/plugins/elements/gstmultiqueue.c
+++ b/plugins/elements/gstmultiqueue.c
@@ -272,11 +272,32 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
       GST_DEBUG_FUNCPTR (gst_multi_queue_get_property);
 
   /* SIGNALS */
+
+  /**
+   * GstMultiQueue::underrun:
+   * @multiqueue: the multqueue instance
+   *
+   * This signal is emitted from the streaming thread when there is
+   * no data in any of the queues inside the multiqueue instance (underrun).
+   *
+   * This indicates either starvation or EOS from the upstream data sources.
+   */
   gst_multi_queue_signals[SIGNAL_UNDERRUN] =
       g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
       G_STRUCT_OFFSET (GstMultiQueueClass, underrun), NULL, NULL,
       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 
+  /**
+   * GstMultiQueue::overrun:
+   * @multiqueue: the multiqueue instance
+   *
+   * Reports that one of the queues in the multiqueue is full (overrun).
+   * A queue is full if the total amount of data inside it (num-buffers, time,
+   * size) is higher than the boundary values which can be set through the
+   * GObject properties.
+   *
+   * This can be used as an indicator of pre-roll. 
+   */
   gst_multi_queue_signals[SIGNAL_OVERRUN] =
       g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
       G_STRUCT_OFFSET (GstMultiQueueClass, overrun), NULL, NULL,