[asterisk-commits] rmudgett: branch group/issue8824 r183195 - in /team/group/issue8824: include/...

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Thu Mar 19 11:39:52 CDT 2009


Author: rmudgett
Date: Thu Mar 19 11:39:46 2009
New Revision: 183195

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=183195
Log:
Addressed some of Russell's comments about comments.

Modified:
    team/group/issue8824/include/asterisk/callerid.h
    team/group/issue8824/include/asterisk/channel.h
    team/group/issue8824/main/callerid.c
    team/group/issue8824/main/channel.c

Modified: team/group/issue8824/include/asterisk/callerid.h
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/include/asterisk/callerid.h?view=diff&rev=183195&r1=183194&r2=183195
==============================================================================
--- team/group/issue8824/include/asterisk/callerid.h (original)
+++ team/group/issue8824/include/asterisk/callerid.h Thu Mar 19 11:39:46 2009
@@ -368,7 +368,8 @@
  * \arg \ref CID Caller ID names and numbers
  */
 
-/*! \brief redirecting reason codes.
+/*!
+ * \brief redirecting reason codes.
  *
  * This list attempts to encompass redirecting reasons
  * as defined by several channel technologies.
@@ -388,8 +389,32 @@
 	AST_REDIRECTING_REASON_CALL_FWD_DTE,           /* This is something defined in Q.931, and no I don't know what it means */
 };
 
+/*!
+ * \brief Convert redirecting reason text code to value (used in config file parsing)
+ *
+ * \param data text string from config file
+ *
+ * \retval Q931_REDIRECTING_REASON from callerid.h
+ * \retval -1 if not in table
+ */
 int ast_redirecting_reason_parse(const char *data);
+
+/*!
+ * \brief Convert redirecting reason value to explanatory string
+ *
+ * \param data Q931_REDIRECTING_REASON from callerid.h
+ *
+ * \return string for human presentation
+ */
 const char *ast_redirecting_reason_describe(int data);
+
+/*!
+ * \brief Convert redirecting reason value to text code
+ *
+ * \param data Q931_REDIRECTING_REASON from callerid.h
+ *
+ * \return string for config file
+ */
 const char *ast_redirecting_reason_name(int data);
 
 /*!
@@ -397,19 +422,43 @@
  */
 enum AST_CONNECTED_LINE_UPDATE_SOURCE {
 	/*! Update for unknown reason (May be interpreted to mean from answer) */
-	AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN,   
+	AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN,
 	/*! Update from normal call answering */
-	AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER,    
+	AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER,
 	/*! Update from call diversion (Deprecated, use REDIRECTING updates instead.) */
-	AST_CONNECTED_LINE_UPDATE_SOURCE_DIVERSION, 
+	AST_CONNECTED_LINE_UPDATE_SOURCE_DIVERSION,
 	/*! Update from call transfer(active) (Party has already answered) */
-	AST_CONNECTED_LINE_UPDATE_SOURCE_TRANSFER,   
+	AST_CONNECTED_LINE_UPDATE_SOURCE_TRANSFER,
 	/*! Update from call transfer(alerting) (Party has not answered yet) */
-	AST_CONNECTED_LINE_UPDATE_SOURCE_TRANSFER_ALERTING   
+	AST_CONNECTED_LINE_UPDATE_SOURCE_TRANSFER_ALERTING
 };
 
+/*!
+ * \brief Convert connected line update source text code to value (used in config file parsing)
+ *
+ * \param data text string from config file
+ *
+ * \retval AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
+ * \retval -1 if not in table
+ */
 int ast_connected_line_source_parse(const char *data);
+
+/*!
+ * \brief Convert connected line update source value to explanatory string
+ *
+ * \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
+ *
+ * \return string for human presentation
+ */
 const char *ast_connected_line_source_describe(int data);
+
+/*!
+ * \brief Convert connected line update source value to text code
+ *
+ * \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
+ *
+ * \return string for config file
+ */
 const char *ast_connected_line_source_name(int data);
 
 

Modified: team/group/issue8824/include/asterisk/channel.h
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/include/asterisk/channel.h?view=diff&rev=183195&r1=183194&r2=183195
==============================================================================
--- team/group/issue8824/include/asterisk/channel.h (original)
+++ team/group/issue8824/include/asterisk/channel.h Thu Mar 19 11:39:46 2009
@@ -2015,24 +2015,157 @@
 };
 
 
+/*!
+ * \brief Copy the source caller information to the destination caller.
+ *
+ * \param dest Destination caller
+ * \param src Source caller
+ *
+ * \return Nothing
+ */
 void ast_party_caller_copy(struct ast_callerid *dest, const struct ast_callerid *src);
 
+/*!
+ * \brief Initialize the given connected line structure.
+ *
+ * \param init Connected line structure to initialize.
+ *
+ * \return Nothing
+ */
 void ast_party_connected_line_init(struct ast_party_connected_line *init);
+
+/*!
+ * \brief Copy the source connected line information to the destination connected line.
+ *
+ * \param dest Destination connected line
+ * \param src Source connected line
+ *
+ * \return Nothing
+ */
 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
+
+/*!
+ * \brief Initialize the given connected line structure using the given
+ * guide for a set update operation.
+ *
+ * \details
+ * The initialization is needed to allow a set operation to know if a
+ * value needs to be updated.  Simple integers need the guide's original
+ * value in case the set operation is not trying to set a new value.
+ * String values are simply set to NULL pointers if they are not going
+ * to be updated.
+ *
+ * \param init Connected line structure to initialize.
+ * \param guide Source connected line to use as a guide in initializing.
+ *
+ * \return Nothing
+ */
 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
+
+/*!
+ * \brief Set the connected line information based on another connected line source
+ *
+ * This is similar to ast_party_connected_line_copy, except that NULL values for
+ * strings in the src parameter indicate not to update the corresponding dest values.
+ *
+ * \param src The source connected line to use as a guide to set the dest
+ * \param dest The connected line one wishes to update
+ *
+ * \return Nada
+ */
 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
+
+/*!
+ * \brief Collect the caller party information into a connected line structure.
+ *
+ * \param connected Collected caller information for the connected line
+ * \param cid Caller information.
+ *
+ * \return Nothing
+ *
+ * \warning This is a shallow copy.
+ * \warning DO NOT call ast_party_connected_line_free() on the filled in
+ * connected line structure!
+ */
 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_callerid *cid);
+
+/*!
+ * \brief Destroy the connected line information contents
+ *
+ * \param doomed The connected line information to destroy.
+ *
+ * \return Nothing
+ */
 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
 
+/*!
+ * \brief Copy the source redirecting information to the destination redirecting.
+ *
+ * \param dest Destination redirecting
+ * \param src Source redirecting
+ *
+ * \return Nothing
+ */
 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
+
+/*!
+ * \brief Initialize the given redirecting id structure using the given guide
+ * for a set update operation.
+ *
+ * \details
+ * The initialization is needed to allow a set operation to know if a
+ * value needs to be updated.  Simple integers need the guide's original
+ * value in case the set operation is not trying to set a new value.
+ * String values are simply set to NULL pointers if they are not going
+ * to be updated.
+ *
+ * \param init Redirecting id structure to initialize.
+ * \param guide Source redirecting id to use as a guide in initializing.
+ *
+ * \return Nothing
+ */
 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
+
+/*!
+ * \brief Destroy the redirecting information contents
+ *
+ * \param doomed The redirecting information to destroy.
+ *
+ * \return Nothing
+ */
 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
 
+/*!
+ * \brief Copy the caller information to the connected line information.
+ *
+ * \param dest Destination connected line information
+ * \param src Source caller information
+ *
+ * \return Nothing
+ *
+ * \note Assumes locks are already acquired
+ */
 void ast_copy_caller_to_connected(struct ast_party_connected_line *dest, const struct ast_callerid *src);
+
+/*!
+ * \brief Copy the connected line information to the caller information.
+ *
+ * \param dest Destination caller information
+ * \param src Source connected line information
+ *
+ * \return Nothing
+ *
+ * \note Assumes locks are already acquired
+ */
 void ast_copy_connected_to_caller(struct ast_callerid *dest, const struct ast_party_connected_line *src);
 
 /*!
- * \brief Set the connected line id information in the Asterisk channel
+ * \brief Set the connected line information in the Asterisk channel
+ *
+ * \param chan Asterisk channel to set connected line information
+ * \param connected Connected line information
+ *
+ * \return Nothing
  *
  * \note The channel does not need to be locked before calling this function.
  */
@@ -2040,38 +2173,88 @@
 
 /*!
  * \brief Parse connected line indication frame data
+ *
+ * \param data Buffer with the frame data to parse
+ * \param datalen Size of the buffer
+ * \param connected Extracted connected line information
+ *
+ * \retval 0 on success.
+ * \retval -1 on error.
+ *
+ * \note The filled in connected line structure needs to be initialized by
+ * ast_party_connected_line_set_init() before calling.  If defaults are not
+ * required use ast_party_connected_line_init().
+ * \note The filled in connected line structure needs to be destroyed by
+ * ast_party_connected_line_free() when it is no longer needed.
  */
 int ast_parse_connected_line_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
 
 /*!
- * \brief Indicate that the connected line has changed
+ * \brief Indicate that the connected line information has changed
+ *
+ * \param chan Asterisk channel to indicate connected line information
+ * \param connected Connected line information
+ *
+ * \return Nothing
  */
 void ast_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected);
 
 /*!
  * \brief Queue a connected line update frame on a channel
+ *
+ * \param chan Asterisk channel to indicate connected line information
+ * \param connected Connected line information
+ *
+ * \return Nothing
  */
 void ast_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected);
 
 /*!
  * \brief Set the redirecting id information in the Asterisk channel
  *
+ * \param chan Asterisk channel to set redirecting id information
+ * \param redirecting Redirecting id information
+ *
+ * \return Nothing
+ *
  * \note The channel does not need to be locked before calling this function.
  */
 void ast_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
 
 /*!
  * \brief Parse redirecting indication frame data
+ *
+ * \param data Buffer with the frame data to parse
+ * \param datalen Size of the buffer
+ * \param redirecting Extracted redirecting id information
+ *
+ * \retval 0 on success.
+ * \retval -1 on error.
+ *
+ * \note The filled in id structure needs to be initialized by
+ * ast_party_redirecting_set_init() before calling.
+ * \note The filled in id structure needs to be destroyed by
+ * ast_party_redirecting_free() when it is no longer needed.
  */
 int ast_parse_redirecting_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
 
 /*!
- * \brief Indicate that the redirecting has changed
+ * \brief Indicate that the redirecting id has changed
+ *
+ * \param chan Asterisk channel to indicate redirecting id information
+ * \param redirecting Redirecting id information
+ *
+ * \return Nothing
  */
 void ast_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
 
 /*!
  * \brief Queue a redirecting update frame on a channel
+ *
+ * \param chan Asterisk channel to indicate redirecting id information
+ * \param redirecting Redirecting id information
+ *
+ * \return Nothing
  */
 void ast_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
 

Modified: team/group/issue8824/main/callerid.c
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/main/callerid.c?view=diff&rev=183195&r1=183194&r2=183195
==============================================================================
--- team/group/issue8824/main/callerid.c (original)
+++ team/group/issue8824/main/callerid.c Thu Mar 19 11:39:46 2009
@@ -1221,14 +1221,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert redirecting reason text code to value (used in config file parsing)
- *
- * \param data text string from config file
- *
- * \retval Q931_REDIRECTING_REASON from callerid.h
- * \retval -1 if not in table
- */
 int ast_redirecting_reason_parse(const char *data)
 {
 	int index;
@@ -1246,13 +1238,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert redirecting reason value to explanatory string
- *
- * \param data Q931_REDIRECTING_REASON from callerid.h
- *
- * \return string for human presentation
- */
 const char *ast_redirecting_reason_describe(int data)
 {
 	int index;
@@ -1270,13 +1255,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert redirecting reason value to text code
- *
- * \param data Q931_REDIRECTING_REASON from callerid.h
- *
- * \return string for config file
- */
 const char *ast_redirecting_reason_name(int data)
 {
 	int index;
@@ -1314,14 +1292,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert connected line update source text code to value (used in config file parsing)
- *
- * \param data text string from config file
- *
- * \retval AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
- * \retval -1 if not in table
- */
 int ast_connected_line_source_parse(const char *data)
 {
 	int index;
@@ -1339,13 +1309,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert connected line update source value to explanatory string
- *
- * \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
- *
- * \return string for human presentation
- */
 const char *ast_connected_line_source_describe(int data)
 {
 	int index;
@@ -1363,13 +1326,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Convert connected line update source value to text code
- *
- * \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
- *
- * \return string for config file
- */
 const char *ast_connected_line_source_name(int data)
 {
 	int index;

Modified: team/group/issue8824/main/channel.c
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/main/channel.c?view=diff&rev=183195&r1=183194&r2=183195
==============================================================================
--- team/group/issue8824/main/channel.c (original)
+++ team/group/issue8824/main/channel.c Thu Mar 19 11:39:46 2009
@@ -1332,7 +1332,7 @@
 
 /* ******************************************************************* */
 /*!
- * \internal 
+ * \internal
  * \brief Copy the source party id information to the destination party id.
  *
  * \param dest Destination party id
@@ -1457,14 +1457,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Copy the source caller information to the destination caller.
- *
- * \param dest Destination caller
- * \param src Source caller
- *
- * \return Nothing
- */
 void ast_party_caller_copy(struct ast_callerid *dest, const struct ast_callerid *src)
 {
 	if (dest == src) {
@@ -1501,6 +1493,7 @@
 #else
 
 	/* The src and dest parameter types will become struct ast_party_caller ptrs. */
+	/* This is future code */
 
 	ast_party_id_copy(&dest->id, &src->id);
 
@@ -1517,13 +1510,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Initialize the given connected line structure.
- *
- * \param init Connected line structure to initialize.
- *
- * \return Nothing
- */
 void ast_party_connected_line_init(struct ast_party_connected_line *init)
 {
 	ast_party_id_init(&init->id);
@@ -1536,14 +1522,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Copy the source connected line information to the destination connected line.
- *
- * \param dest Destination connected line
- * \param src Source connected line
- *
- * \return Nothing
- */
 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
 {
 	if (dest == src) {
@@ -1566,22 +1544,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Initialize the given connected line structure using the given
- * guide for a set update operation.
- *
- * \details
- * The initialization is needed to allow a set operation to know if a
- * value needs to be updated.  Simple integers need the guide's original
- * value in case the set operation is not trying to set a new value.
- * String values are simply set to NULL pointers if they are not going
- * to be updated.
- *
- * \param init Connected line structure to initialize.
- * \param guide Source connected line to use as a guide in initializing.
- *
- * \return Nothing
- */
 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide)
 {
 	ast_party_id_set_init(&init->id, &guide->id);
@@ -1590,16 +1552,7 @@
 	init->source = guide->source;
 }	/* end ast_party_connected_line_set_init() */
 
-/*! \brief Set the connected line information based on another connected line source
- *
- * This is similar to ast_party_connected_line_copy, except that NULL values for
- * strings in the src parameter indicate not to update the corresponding dest values.
- *
- * \param src The source connected line to use as a guide to set the dest
- * \param dest The connected line one wishes to update
- *
- * \return Nada
- */
+
 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
 {
 	ast_party_id_set(&dest->id, &src->id);
@@ -1617,18 +1570,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Collect the caller party information into a connected line structure.
- * 
- * \param connected Collected caller information for the connected line
- * \param cid Caller information.
- * 
- * \return Nothing
- * 
- * \warning This is a shallow copy.
- * \warning DO NOT call ast_party_connected_line_free() on the filled in
- * connected line structure!
- */
 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_callerid *cid)
 {
 	connected->id.number = cid->cid_num;
@@ -1645,13 +1586,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Destroy the connected line information contents
- *
- * \param doomed The connected line information to destroy.
- *
- * \return Nothing
- */
 void ast_party_connected_line_free(struct ast_party_connected_line *doomed)
 {
 	ast_party_id_free(&doomed->id);
@@ -1666,14 +1600,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Copy the source redirecting information to the destination redirecting.
- *
- * \param dest Destination redirecting
- * \param src Source redirecting
- *
- * \return Nothing
- */
 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src)
 {
 	if (dest == src) {
@@ -1691,22 +1617,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Initialize the given redirecting id structure using the given guide
- * for a set update operation.
- *
- * \details
- * The initialization is needed to allow a set operation to know if a
- * value needs to be updated.  Simple integers need the guide's original
- * value in case the set operation is not trying to set a new value.
- * String values are simply set to NULL pointers if they are not going
- * to be updated.
- *
- * \param init Redirecting id structure to initialize.
- * \param guide Source redirecting id to use as a guide in initializing.
- *
- * \return Nothing
- */
 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide)
 {
 	ast_party_id_set_init(&init->from, &guide->from);
@@ -1720,13 +1630,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Destroy the redirecting information contents
- *
- * \param doomed The redirecting information to destroy.
- *
- * \return Nothing
- */
 void ast_party_redirecting_free(struct ast_party_redirecting *doomed)
 {
 	ast_party_id_free(&doomed->from);
@@ -5983,16 +5886,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Copy the caller information to the connected line information.
- *
- * \param dest Destination connected line information
- * \param src Source caller information
- *
- * \return Nothing
- *
- * \note Assumes locks are already acquired
- */
 void ast_copy_caller_to_connected(struct ast_party_connected_line *dest, const struct ast_callerid *src)
 {
 #if 1
@@ -6018,9 +5911,10 @@
 
 	dest->ani2 = src->cid_ani2;
 
-#else	
+#else
 
 	/* The src parameter type will become a struct ast_party_caller ptr. */
+	/* This is future code */
 
 	ast_party_id_copy(&dest->id, &src->id);
 
@@ -6030,23 +5924,13 @@
 	dest->ani = ast_strdup(src->ani);
 
 	dest->ani2 = src->ani2;
-#endif	
+#endif
 }	/* end ast_copy_caller_to_connected() */
 
 
 
 
 /* ******************************************************************* */
-/*!
- * \brief Copy the connected line information to the caller information.
- *
- * \param dest Destination caller information
- * \param src Source connected line information
- *
- * \return Nothing
- *
- * \note Assumes locks are already acquired
- */
 void ast_copy_connected_to_caller(struct ast_callerid *dest, const struct ast_party_connected_line *src)
 {
 #if 1
@@ -6072,9 +5956,10 @@
 
 	dest->cid_ani2 = src->ani2;
 
-#else	
+#else
 
 	/* The dest parameter type will become a struct ast_party_caller ptr. */
+	/* This is future code */
 
 	ast_party_id_copy(&dest->id, &src->id);
 
@@ -6084,23 +5969,13 @@
 	dest->ani = ast_strdup(src->ani);
 
 	dest->ani2 = src->ani2;
-#endif	
+#endif
 }	/* end ast_copy_connected_to_caller() */
 
 
 
 
 /* ******************************************************************* */
-/*!
- * \brief Set the connected line information in the Asterisk channel
- *
- * \param chan Asterisk channel to set connected line information
- * \param connected Connected line information
- *
- * \return Nothing
- *
- * \note The channel does not need to be locked before calling this function.
- */
 void ast_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected)
 {
 	if (&chan->connected == connected) {
@@ -6213,22 +6088,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Parse connected line indication frame data
- *
- * \param data Buffer with the frame data to parse
- * \param datalen Size of the buffer
- * \param connected Extracted connected line information
- *
- * \retval 0 on success.
- * \retval -1 on error.
- *
- * \note The filled in connected line structure needs to be initialized by
- * ast_party_connected_line_set_init() before calling.  If defaults are not
- * required use ast_party_connected_line_init().
- * \note The filled in connected line structure needs to be destroyed by
- * ast_party_connected_line_free() when it is no longer needed.
- */
 int ast_parse_connected_line_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected)
 {
 	size_t pos;
@@ -6304,14 +6163,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Indicate that the connected line information has changed
- *
- * \param chan Asterisk channel to indicate connected line information
- * \param connected Connected line information
- *
- * \return Nothing
- */
 void ast_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected)
 {
 	unsigned char data[1024];	/* This should be large enough */
@@ -6329,14 +6180,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Queue a connected line update frame on a channel
- *
- * \param chan Asterisk channel to indicate connected line information
- * \param connected Connected line information
- *
- * \return Nothing
- */
 void ast_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected)
 {
 	unsigned char data[1024];	/* This should be large enough */
@@ -6354,16 +6197,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Set the redirecting id information in the Asterisk channel
- *
- * \param chan Asterisk channel to set redirecting id information
- * \param redirecting Redirecting id information
- *
- * \return Nothing
- *
- * \note The channel does not need to be locked before calling this function.
- */
 void ast_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
 {
 	if (&chan->redirecting == redirecting) {
@@ -6550,21 +6383,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Parse redirecting indication frame data
- *
- * \param data Buffer with the frame data to parse
- * \param datalen Size of the buffer
- * \param redirecting Extracted redirecting id information
- *
- * \retval 0 on success.
- * \retval -1 on error.
- *
- * \note The filled in id structure needs to be initialized by
- * ast_party_redirecting_set_init() before calling.
- * \note The filled in id structure needs to be destroyed by
- * ast_party_redirecting_free() when it is no longer needed.
- */
 int ast_parse_redirecting_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting)
 {
 	size_t pos;
@@ -6682,14 +6500,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Indicate that the redirecting id has changed
- *
- * \param chan Asterisk channel to indicate redirecting id information
- * \param redirecting Redirecting id information
- *
- * \return Nothing
- */
 void ast_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
 {
 	unsigned char data[1024];	/* This should be large enough */
@@ -6707,14 +6517,6 @@
 
 
 /* ******************************************************************* */
-/*!
- * \brief Queue a redirecting update frame on a channel
- *
- * \param chan Asterisk channel to indicate redirecting id information
- * \param redirecting Redirecting id information
- *
- * \return Nothing
- */
 void ast_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
 {
 	unsigned char data[1024];	/* This should be large enough */




More information about the asterisk-commits mailing list