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

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Sun Jan  4 14:55:52 2009
New Revision: 167168

URL: http://svn.digium.com/view/asterisk?view=rev&rev=167168
Log:
Add more doxygen.

This branch is nearly ready for a code review :)

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=167168&r1=167167&r2=167168
==============================================================================
--- team/mmichelson/queue-reset/apps/app_queue.c (original)
+++ team/mmichelson/queue-reset/apps/app_queue.c Sun Jan  4 14:55:52 2009
@@ -5776,6 +5776,19 @@
 	return 1;
 }
 
+/*! \brief Facilitates resetting statistics for a queue
+ *
+ * This function actually does not reset any statistics, but
+ * rather finds a call_queue struct which corresponds to the
+ * passed-in queue name and passes that structure to the 
+ * clear_queue function. If no queuename is passed in, then
+ * all queues will have their statistics reset.
+ *
+ * \param queuename The name of the queue to reset the statistics
+ * for. If this is NULL or zero-length, then this means to reset
+ * the statistics for all queues
+ * \retval void
+ */
 static void clear_stats(const char *queuename)
 {
 	struct call_queue *q;
@@ -5786,6 +5799,18 @@
 	}
 }
 
+/*! \brief The command center for all reload operations
+ *
+ * Whenever any piece of queue information is to be reloaded, this function
+ * is called. It interprets the flags set in the mask parameter and acts
+ * based on how they are set.
+ *
+ * \param reload True if we are reloading information, false if we are loading
+ * information for the first time.
+ * \param mask A bitmask which tells the handler what actions to take
+ * \param queuename The name of the queue on which we wish to take action
+ * \retval 0 We always return 0
+ */
 static int reload_handler(int reload, struct ast_flags *mask, const char *queuename)
 {
 	if (ast_test_flag(mask, QUEUE_RELOAD_RULES)) {
@@ -5797,7 +5822,7 @@
 	if (ast_test_flag(mask, (QUEUE_RELOAD_PARAMETERS | QUEUE_RELOAD_MEMBER))) {
 		reload_queues(reload, mask, queuename);
 	}
-	return 1;
+	return 0;
 }
 
 /*! \brief direct ouput to manager or cli with proper terminator */