From: Travis Cross <tc@traviscross.com>
Date: Mon, 26 May 2014 18:00:02 +0000 (+0000)
Subject: mod_fifo: Document the fifo_queue_t structure
X-Git-Tag: v1.4.5~2^2~14^2~18
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=42ebfbfc5980baa35fbf9c1e4704201ec8dfcb8f;p=thirdparty%2Ffreeswitch.git

mod_fifo: Document the fifo_queue_t structure
---

diff --git a/src/mod/applications/mod_fifo/mod_fifo.c b/src/mod/applications/mod_fifo/mod_fifo.c
index 911cd1fa4d..42f030d3c5 100644
--- a/src/mod/applications/mod_fifo/mod_fifo.c
+++ b/src/mod/applications/mod_fifo/mod_fifo.c
@@ -111,6 +111,16 @@ typedef enum {
 	NODE_STRATEGY_ENTERPRISE
 } outbound_strategy_t;
 
+/*!\struct fifo_queue_t
+ * \brief Queue of callers
+ *
+ * Callers are placed into a queue as events in `data` which is an
+ * array of such events.  The array size is hard-coded as 1000
+ * elements.
+ *
+ * Fifo nodes are composed of an array of these queues representing
+ * each priority level of the fifo.
+ */
 typedef struct {
 	int nelm;
 	int idx;