From: Travis Cross <tc@traviscross.com>
Date: Mon, 26 May 2014 14:42:20 +0000 (+0000)
Subject: mod_fifo: Document remove parameter of fifo_queue_pop()
X-Git-Tag: v1.4.5~2^2~14^2~27
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1eaf4b50caae97ebc4d8aa25e3ad9e6363f70f93;p=thirdparty%2Ffreeswitch.git

mod_fifo: Document remove parameter of fifo_queue_pop()
---

diff --git a/src/mod/applications/mod_fifo/mod_fifo.c b/src/mod/applications/mod_fifo/mod_fifo.c
index d60cc71e26..1cf1d0cf9e 100644
--- a/src/mod/applications/mod_fifo/mod_fifo.c
+++ b/src/mod/applications/mod_fifo/mod_fifo.c
@@ -197,6 +197,12 @@ static int fifo_queue_size(fifo_queue_t *queue)
 	return s;
 }
 
+/*!
+ * \param remove Whether to remove the popped event from the queue
+ * If remove is 0, do not remove the popped event.  If it is 1, remove
+ * it if it is not an event for an outbound caller.  If it is 2,
+ * always remove it.
+ */
 static switch_status_t fifo_queue_pop(fifo_queue_t *queue, switch_event_t **pop, int remove)
 {
 	int i, j;