[asterisk-commits] russell: branch group/newcdr r202876 - /team/group/newcdr/include/asterisk/cel.h
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Tue Jun 23 22:10:37 CDT 2009
Author: russell
Date: Tue Jun 23 22:10:33 2009
New Revision: 202876
URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=202876
Log:
Add \since tags
Modified:
team/group/newcdr/include/asterisk/cel.h
Modified: team/group/newcdr/include/asterisk/cel.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/newcdr/include/asterisk/cel.h?view=diff&rev=202876&r1=202875&r2=202876
==============================================================================
--- team/group/newcdr/include/asterisk/cel.h (original)
+++ team/group/newcdr/include/asterisk/cel.h Tue Jun 23 22:10:33 2009
@@ -28,7 +28,7 @@
#include "asterisk/event.h"
-/*! AMA Flags */
+/*! \brief AMA Flags */
enum ast_cel_ama_flag {
AST_CEL_AMA_FLAG_OMIT,
AST_CEL_AMA_FLAG_BILLING,
@@ -96,6 +96,8 @@
/*!
* \brief Check to see if CEL is enabled
*
+ * \since 1.6.3
+ *
* \retval zero not enabled
* \retval non-zero enabled
*/
@@ -104,6 +106,8 @@
/*!
* \brief Allocate a CEL record
*
+ * \since 1.6.3
+ *
* \note The CEL record must be destroyed with ast_cel_destroy().
*
* \retval non-NULL an allocated ast_cel structure
@@ -116,6 +120,8 @@
*
* \param cel the record to destroy
*
+ * \since 1.6.3
+ *
* \return nothing.
*/
void ast_cel_destroy(struct ast_cel *cel);
@@ -125,6 +131,8 @@
*
* \param type the type to get the name of
*
+ * \since 1.6.3
+ *
* \return the string representation of the type
*/
const char *ast_cel_get_type_name(enum ast_cel_event_type type);
@@ -133,6 +141,8 @@
* \brief Get the event type from a string
*
* \param name the event type name as a string
+ *
+ * \since 1.6.3
*
* \return the ast_cel_event_type given by the string
*/
@@ -143,6 +153,8 @@
*
* \param[in] flag the flag to convert to a string
*
+ * \since 1.6.3
+ *
* \return the string representation of the flag
*/
const char *ast_cel_get_ama_flag_name(enum ast_cel_ama_flag flag);
@@ -151,6 +163,8 @@
* \brief Check and potentially retire a Linked ID
*
* \param chan channel that is being destroyed or its linkedid is changing
+ *
+ * \since 1.6.3
*
* If at least one CEL backend is looking for CEL_LINKEDID_END
* events, this function will check if the given channel is the last
@@ -168,6 +182,8 @@
* in the given cel event. It must be released with ast_channel_release.
*
* \param event the CEL event
+ *
+ * \since 1.6.3
*
* \return a channel with the data filled in, or NULL on error
*
@@ -191,6 +207,8 @@
* chan. If chan has no bridged channel and peer2 is specified, then the name
* of peer2 will go into the "peer name" field. If neither are available, the
* peer name field will be blank.
+ *
+ * \since 1.6.3
*
* \pre chan and peer2 are both unlocked
*
@@ -244,6 +262,8 @@
* \param[in] event the CEL event
* \param[out] r the ast_cel_event_record to fill in
*
+ * \since 1.6.3
+ *
* \retval 0 success
* \retval non-zero failure
*/
More information about the asterisk-commits
mailing list