From 4fa54750f68ccac4f0a26d51b6a2ab98f47a1815 Mon Sep 17 00:00:00 2001
From: Jan Schmidt <thaytan@mad.scientist.com>
Date: Fri, 9 May 2008 14:02:53 +0000
Subject: [PATCH] plugins/elements/gstmultiqueue.c: Add documentation for the
 signals to push our core plugin docs coverage back up to ...

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%.
---
 ChangeLog                        |  6 ++++++
 common                           |  2 +-
 plugins/elements/gstmultiqueue.c | 21 +++++++++++++++++++++
 3 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/ChangeLog b/ChangeLog
index e6aa023..b7a8fa6 100644
--- 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 ba3dd28..dbf8f3a 160000
--- 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 29a9d7d..78bba70 100644
--- 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,
-- 
2.7.4