[asterisk-commits] mmichelson: branch mmichelson/queue-reset r167015 - /team/mmichelson/queue-re...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Dec 31 14:36:30 2008
New Revision: 167015

URL: http://svn.digium.com/view/asterisk?view=rev&rev=167015
Log:
Add doxygen to functions


Modified:
    team/mmichelson/queue-reset/apps/app_queue.c

Modified: team/mmichelson/queue-reset/apps/app_queue.c
URL: http://svn.digium.com/view/asterisk/team/mmichelson/queue-reset/apps/app_queue.c?view=diff&rev=167015&r1=167014&r2=167015
==============================================================================
--- team/mmichelson/queue-reset/apps/app_queue.c (original)
+++ team/mmichelson/queue-reset/apps/app_queue.c Wed Dec 31 14:36:30 2008
@@ -5502,6 +5502,14 @@
 		shared_lastcall = ast_true(general_val);
 }
 
+/*! \brief reload information pertaining to a single member
+ *
+ * This function is called when a member = line is encountered in
+ * queues.conf.
+ *
+ * \param memberdata The part after member = in the config file
+ * \param q The queue to which this member belongs
+ */
 static void reload_single_member(const char *memberdata, struct call_queue *q)
 {
 	const char *membername, *interface, *state_interface, *tmp;
@@ -5562,9 +5570,18 @@
 		q->membercount++;
 	}
 }
-/* Once we have isolated a queue within reload_queues, we call this. This will either
+
+/*! \brief Reload information pertaining to a particular queue
+ *
+ * Once we have isolated a queue within reload_queues, we call this. This will either
  * reload information for the queue or if we're just reloading member information, we'll just
- * reload that without touching other settings within the queue */
+ * reload that without touching other settings within the queue 
+ *
+ * \param cfg The configuration which we are reading
+ * \param mask Tells us what information we need to reload
+ * \param queuename The name of the queue we are reloading information from
+ * \retval void
+ */
 static void reload_single_queue(struct ast_config *cfg, struct ast_flags *mask, const char *queuename)
 {
 	int new;
@@ -5686,7 +5703,18 @@
 	queue_unref(q);
 }
 
-
+/*! \brief reload the queues.conf file
+ *
+ * This function reloads the information in the general section of the queues.conf
+ * file and potentially more, depending on the value of mask.
+ *
+ * \param reload 0 if we are calling this the first time, 1 every other time
+ * \param mask Gives flags telling us what information to actually reload
+ * \param queuename If set to a non-zero string, then only reload information from
+ * that particular queue. Otherwise inspect all queues
+ * \retval 0 Not a failure, but queues were not reloaded
+ * \retval 1 All clear!
+ */
 static int reload_queues(int reload, struct ast_flags *mask, const char *queuename)
 {
 	struct call_queue *q;