[svn-commits] mmichelson: branch group/CCSS r227491 - /team/group/CCSS/include/asterisk/ccss.h

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Tue Nov  3 16:50:15 2009
New Revision: 227491

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=227491
Log:
Fix up some doxygen.


Modified:
    team/group/CCSS/include/asterisk/ccss.h

Modified: team/group/CCSS/include/asterisk/ccss.h
URL: http://svnview.digium.com/svn/asterisk/team/group/CCSS/include/asterisk/ccss.h?view=diff&rev=227491&r1=227490&r2=227491
==============================================================================
--- team/group/CCSS/include/asterisk/ccss.h (original)
+++ team/group/CCSS/include/asterisk/ccss.h Tue Nov  3 16:50:15 2009
@@ -616,8 +616,8 @@
  * set by the cc_max_requests configuration option
  *
  * It is recommended that an entity which receives an incoming
- * CC request calls this function before changing state to
- * CC_CALLER_REQUESTED. This way, immediate feedback can be
+ * CC request calls this function before calling
+ * ast_cc_accept_request. This way, immediate feedback can be
  * given to the caller about why his request was rejected.
  *
  * If this is not called and a state change to CC_CALLER_REQUESTED
@@ -1042,7 +1042,10 @@
  * channel were passed into this function, then the return would be 0 since
  * SIP/2000 was not one of the original devices dialed.
  *
- * \param chan A called channel
+ * Note also that this function may be called on a calling channel as well to
+ * determine if it is part of a CC recall.
+ *
+ * \param chan The channel to check
  * \param core_id[out] If this is a valid CC recall, the core_id of the failed call
  * will be placed in this output parameter
  * \retval 0 Either this is not a recall or it is but this channel is not part of the recall