[svn-commits] mmichelson: branch mmichelson/issue13220 r182962 - /team/mmichelson/issue1322...

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Wed Mar 18 14:54:55 2009
New Revision: 182962

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=182962
Log:
Clean up doxygen stuff.


Modified:
    team/mmichelson/issue13220/apps/app_queue.c

Modified: team/mmichelson/issue13220/apps/app_queue.c
URL: http://svn.digium.com/svn-view/asterisk/team/mmichelson/issue13220/apps/app_queue.c?view=diff&rev=182962&r1=182961&r2=182962
==============================================================================
--- team/mmichelson/issue13220/apps/app_queue.c (original)
+++ team/mmichelson/issue13220/apps/app_queue.c Wed Mar 18 14:54:55 2009
@@ -1717,7 +1717,14 @@
 	}
 }
 
-/* We assume that q is locked prior to this call */
+/*!
+ * \brief Get the number of members available to accept a call.
+ *
+ * \note The queue passed in should be locked prior to this function call
+ *
+ * \param[in] q The queue for which we are couting the number of available members
+ * \return Return the number of available members in queue q
+ */
 static int num_available_members(struct call_queue *q)
 {
 	struct member *mem;
@@ -2370,12 +2377,13 @@
 
 /*! \brief Check if we should start attempting to call queue members
  *
- * The behavior of this function is dependent first on whether autofill is enabled
- * and second on whether the ring strategy is ringall. If autofill is not enabled,
- * then return true if we're the head of the queue. If autofill is enabled, then
- * we count the available members and see if the number of available members is enough
- * that given our position in the queue, we would theoretically be able to connect to
- * one of those available members
+ * A simple process, really. Count the number of members who are available
+ * to take our call and then see if we are in a position in the queue at
+ * which a member could accept our call.
+ *
+ * \param[in] qe The caller who wants to know if it is his turn
+ * \retval 0 It is not our turn
+ * \retval 1 It is our turn
  */
 static int is_our_turn(struct queue_ent *qe)
 {
@@ -2391,7 +2399,7 @@
 	ch = qe->parent->head;
 
 	if (option_debug) {
-		ast_log(LOG_DEBUG, "There are %d available members.\n", avl);
+		ast_log(LOG_DEBUG, "There %s %d available %s.\n", avl != 1 ? "are" : "is", avl, avl != 1 ? "members" : "member");
 	}
 
 	while ((idx < avl) && (ch) && (ch != qe)) {