mod_fifo: Document fifo_chime_data::list

2014-05-26 17:50:43 +00:00 · 2014-05-26 17:50:43 +00:00 · 5f4ed9c123
parent 2c7c15261d
commit 5f4ed9c123
1 changed files with 6 additions and 0 deletions
--- a/src/mod/applications/mod_fifo/mod_fifo.c
+++ b/src/mod/applications/mod_fifo/mod_fifo.c
@ -565,6 +565,12 @@ static void node_remove_uuid(fifo_node_t *node, const char *uuid)
 	return;
 }

+/*!\struct fifo_chime_data
+ *
+ * \var fifo_chime_data::list
+ * A list of strings representing things to play back to the caller
+ * while they are waiting to be connected with an agent.
+ */
 #define MAX_CHIME 25
 struct fifo_chime_data {
 	char *list[MAX_CHIME];