From 077579b131d7d8c0fcc3540a39f003943b999f09 Mon Sep 17 00:00:00 2001 From: Travis Cross Date: Mon, 26 May 2014 15:01:06 +0000 Subject: [PATCH] mod_fifo: Document fifo_queue_popfly() --- src/mod/applications/mod_fifo/mod_fifo.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/mod/applications/mod_fifo/mod_fifo.c b/src/mod/applications/mod_fifo/mod_fifo.c index ba05976f2e..4621f29be1 100644 --- a/src/mod/applications/mod_fifo/mod_fifo.c +++ b/src/mod/applications/mod_fifo/mod_fifo.c @@ -309,6 +309,12 @@ static switch_status_t fifo_queue_pop_nameval(fifo_queue_t *queue, const char *n return SWITCH_STATUS_SUCCESS; } +/*! \brief Destroy event with given uuid and remove it from queue + * + * Elements of the queue are searched until a matching uuid is found. + * That uuid is then destroyed and removed from the queue. The + * remaining elements are shifted to make them contiguous. + */ static switch_status_t fifo_queue_popfly(fifo_queue_t *queue, const char *uuid) { int i, j;