[asterisk-commits] mmichelson: branch mmichelson/digit_manipulation r198596 - /team/mmichelson/d...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Mon Jun  1 12:26:04 2009
New Revision: 198596

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=198596
Log:
Wrap at 90 lines and add a \since tag to ast_app_run_macro


Modified:
    team/mmichelson/digit_manipulation/include/asterisk/app.h
    team/mmichelson/digit_manipulation/include/asterisk/channel.h

Modified: team/mmichelson/digit_manipulation/include/asterisk/app.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/mmichelson/digit_manipulation/include/asterisk/app.h?view=diff&rev=198596&r1=198595&r2=198596
==============================================================================
--- team/mmichelson/digit_manipulation/include/asterisk/app.h (original)
+++ team/mmichelson/digit_manipulation/include/asterisk/app.h Mon Jun  1 12:26:04 2009
@@ -109,12 +109,14 @@
 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
 
 /*!
+ * \since 1.6.3
  * \brief Run a macro on a channel, placing a second channel into autoservice.
  *
- * This is a shorthand method that makes it very easy to run a macro on any given channel. It is perfectly
- * reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.
- * It is very important that the autoservice_chan parameter is not locked prior to calling ast_app_run_macro.
- * A deadlock could result, otherwise.
+ * This is a shorthand method that makes it very easy to run a macro on any given 
+ * channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case
+ * there is no channel to place into autoservice. It is very important that the 
+ * autoservice_chan parameter is not locked prior to calling ast_app_run_macro. A 
+ * deadlock could result, otherwise.
  *
  * \param autoservice_chan A channel to place into autoservice while the macro is run
  * \param macro_chan The channel to run the macro on
@@ -123,7 +125,8 @@
  * \retval 0 success
  * \retval -1 failure
  */
-int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char * const macro_name, const char * const macro_args);
+int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel 
+		*macro_chan, const char * const macro_name, const char * const macro_args);
 
 /*!
  * \brief Set voicemail function callbacks

Modified: team/mmichelson/digit_manipulation/include/asterisk/channel.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/mmichelson/digit_manipulation/include/asterisk/channel.h?view=diff&rev=198596&r1=198595&r2=198596
==============================================================================
--- team/mmichelson/digit_manipulation/include/asterisk/channel.h (original)
+++ team/mmichelson/digit_manipulation/include/asterisk/channel.h Mon Jun  1 12:26:04 2009
@@ -2552,22 +2552,30 @@
 
 /*!
  * \since 1.6.3
- * \brief Run a connected line interception macro and update a channel's connected line information
- *
- * Whenever we want to update a channel's connected line information, we may need to run a macro so that
- * an administrator can manipulate the information before sending it out. This function both runs the
- * macro and sends the update to the channel.
- *
- * \param autoservice_chan Channel to place into autoservice while the macro is running. It is perfectly safe for this to be NULL
- * \param macro_chan The channel to run the macro on. Also the channel from which we determine which macro we need to run.
- * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type AST_CONTROL_CONNECTED_LINE
- * \param caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
- * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an ast_party_connected_line pointer.
+ * \brief Run a connected line interception macro and update a channel's connected line
+ * information
+ *
+ * Whenever we want to update a channel's connected line information, we may need to run
+ * a macro so that an administrator can manipulate the information before sending it 
+ * out. This function both runs the macro and sends the update to the channel.
+ *
+ * \param autoservice_chan Channel to place into autoservice while the macro is running. 
+ * 	It is perfectly safe for this to be NULL 
+ * \param macro_chan The channel to run the macro on. Also the channel from which we 
+ * 	determine which macro we need to run.
+ * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type 
+ * 	AST_CONTROL_CONNECTED_LINE
+ * \param caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO, otherwise run 
+ * 	CONNECTED_LINE_CALLEE_SEND_MACRO
+ * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an 
+ * 	ast_party_connected_line pointer.
  * \retval 0 Success
- * \retval -1 Either the macro does not exist, or there was an error while attempting to run the macro
+ * \retval -1 Either the macro does not exist, or there was an error while attempting to 
+ * 	run the macro
  *
  * \todo Have multiple return codes based on the MACRO_RESULT
- * \todo Make constants so that caller and frame can be more expressive than just '1' and '0'
+ * \todo Make constants so that caller and frame can be more expressive than just '1' and
+ * 	'0'
  */
 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int caller, int frame);
 #if defined(__cplusplus) || defined(c_plusplus)