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 911cd1fa4d398e778d6430ba33088e2cbc74e5a5..42f030d3c595dca23e32cfb0e27da107a8adc128 100644 (file)
--- 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;