[asterisk-commits] russell: branch russell/chan_refcount r95014 - /team/russell/chan_refcount/in...

[SVN commits to the Asterisk project]

Author: russell
Date: Thu Dec 27 14:37:03 2007
New Revision: 95014

URL: http://svn.digium.com/view/asterisk?view=rev&rev=95014
Log:
Add doxygen docs for ast_channel_get_*() functions

Modified:
    team/russell/chan_refcount/include/asterisk/channel.h

Modified: team/russell/chan_refcount/include/asterisk/channel.h
URL: http://svn.digium.com/view/asterisk/team/russell/chan_refcount/include/asterisk/channel.h?view=diff&rev=95014&r1=95013&r2=95014
==============================================================================
--- team/russell/chan_refcount/include/asterisk/channel.h (original)
+++ team/russell/chan_refcount/include/asterisk/channel.h Thu Dec 27 14:37:03 2007
@@ -1610,14 +1610,48 @@
 
 /*!
  * \brief Call a function with every active channel
+ *
+ * This function executes a callback one time for each active channel on the
+ * system.  The channel is provided as an argument to the function.
  */
 void ast_channel_callback(ao2_callback_fn *cb_fn);
 
-
+/*!
+ * \brief Find a channel by name
+ *
+ * \arg name the name of the channel to search for
+ *
+ * Find a channel that has the same name as the provided argument.
+ *
+ * \retval a channel with the name specified by the argument
+ * \retval NULL if no channel was found
+ */
 struct ast_channel *ast_channel_get_by_name(const char *name);
 
+/*!
+ * \brief Find a channel by a name prefix
+ *
+ * \arg name The channel name prefix to search for
+ * \arg name_len Only search for up to this many characters from the name
+ *
+ * Find a channel that has the same name prefix as specified by the arguments.
+ *
+ * \retval a channel with the name prefix specified by the arguments
+ * \retval NULL if no channel was found
+ */
 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
 
+/*!
+ * \brief Find a channel by extension and context
+ *
+ * \arg exten the extension to search for
+ * \arg context the context to search for
+ *
+ * Return a channel that is currently at the specified extension and context.
+ *
+ * \retval a channel that is at the specified extension and context
+ * \retval NULL if no channel was found
+ */
 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
 
 #if defined(__cplusplus) || defined(c_plusplus)