[svn-commits] mmichelson: branch group/CCSS r247844 - /team/group/CCSS/main/ccss.c

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Thu Feb 18 17:15:15 2010
New Revision: 247844

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=247844
Log:
Add doxygen for internal functions created earlier today.


Modified:
    team/group/CCSS/main/ccss.c

Modified: team/group/CCSS/main/ccss.c
URL: http://svnview.digium.com/svn/asterisk/team/group/CCSS/main/ccss.c?view=diff&rev=247844&r1=247843&r2=247844
==============================================================================
--- team/group/CCSS/main/ccss.c (original)
+++ team/group/CCSS/main/ccss.c Thu Feb 18 17:15:15 2010
@@ -3047,6 +3047,23 @@
 	return monitor_iter;
 }
 
+/*!
+ * \internal
+ * \brief uniquely append a dialstring to our CC_INTERFACES chanvar string.
+ *
+ * We will only append a string if it has not already appeared in our channel
+ * variable earlier. We ensure that we don't erroneously match substrings by
+ * adding an ampersand to the end of our potential dialstring and searching for
+ * it plus the ampersand in our variable.
+ *
+ * It's important to note that once we have built the full CC_INTERFACES string,
+ * there will be an extra ampersand at the end which must be stripped off by
+ * the caller of this function.
+ *
+ * \param str An ast_str holding what we will add to CC_INTERFACES
+ * \param dialstring A new dialstring to add
+ * \retval void
+ */
 static void cc_unique_append(struct ast_str *str, const char * const dialstring)
 {
 	char dialstring_search[AST_CHANNEL_NAME];
@@ -3060,6 +3077,21 @@
 	ast_str_append(&str, 0, "%s", dialstring_search);
 }
 
+/*!
+ * \internal
+ * \brief Build the CC_INTERFACES channel variable
+ *
+ * The method used is to traverse the child dialstrings in the
+ * passed-in extension monitor, adding any that have the is_valid
+ * flag set. Then, traverse the monitors, finding all children
+ * of the starting extension monitor and adding their dialstrings
+ * as well.
+ *
+ * \param starting_point The extension monitor that is the parent to all
+ * monitors whose dialstrings should be added to CC_INTERFACES
+ * \param str Where we will store CC_INTERFACES
+ * \retval void
+ */
 static void build_cc_interfaces_chanvar(struct ast_cc_monitor *starting_point, struct ast_str *str)
 {
 	struct extension_monitor_pvt *extension_pvt;