From: Travis Cross <tc@traviscross.com>
Date: Mon, 26 May 2014 16:10:34 +0000 (+0000)
Subject: mod_fifo: Document load_config()
X-Git-Tag: v1.4.5~2^2~14^2~45
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8ccd13bd9aa631bc51dddee2754a74719ff004dd;p=thirdparty%2Ffreeswitch.git

mod_fifo: Document load_config()
---

diff --git a/src/mod/applications/mod_fifo/mod_fifo.c b/src/mod/applications/mod_fifo/mod_fifo.c
index b77b2adc14..c557b3ab97 100644
--- a/src/mod/applications/mod_fifo/mod_fifo.c
+++ b/src/mod/applications/mod_fifo/mod_fifo.c
@@ -4338,6 +4338,20 @@ static void extract_fifo_outbound_uuid(char *string, char *uuid, switch_size_t l
 	switch_event_destroy(&ovars);
 }
 
+/*!
+ * Load or reload the configuration
+ *
+ * On the initial load, non-static members are preserved unless the
+ * parameter `delete-all-outbound-members-on-startup` is set.  The
+ * parameter `del_all` is ignored in this case.
+ *
+ * On reload, non-static members are preserved unless `del_all` is
+ * set.
+ *
+ * \param reload true if we're reloading the config
+ * \param del_all delete all outbound members when reloading;
+ *   not used unless reload is true
+ */
 static switch_status_t load_config(int reload, int del_all)
 {
 	char *cf = "fifo.conf";