[asterisk-commits] tilghman: trunk r38521 - /trunk/include/asterisk/app.h

[asterisk-commits at lists.digium.com]

Author: tilghman
Date: Sun Jul 30 10:02:34 2006
New Revision: 38521

URL: http://svn.digium.com/view/asterisk?rev=38521&view=rev
Log:
Add details about flash and wait to doxygen about DTMF.
Reformat the lines to break at column 80.

Modified:
    trunk/include/asterisk/app.h

Modified: trunk/include/asterisk/app.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/app.h?rev=38521&r1=38520&r2=38521&view=diff
==============================================================================
--- trunk/include/asterisk/app.h (original)
+++ trunk/include/asterisk/app.h Sun Jul 30 10:02:34 2006
@@ -144,12 +144,17 @@
   \brief Send DTMF to a channel
 
   \param chan    The channel that will receive the DTMF frames
-  \param peer    (optional) Peer channel that will be autoserviced while the primary
-                 channel is receiving DTMF
-  \param digits  This is a string of characters representing the DTMF digits to be sent
-                 to the channel.  Valid characters are "0123456789*#abcdABCD".
-  \param between This is the number of milliseconds to wait in between each DTMF digit.
-                 If zero milliseconds is specified, then the default value of 100 will be used.
+  \param peer    (optional) Peer channel that will be autoserviced while the
+                 primary channel is receiving DTMF
+  \param digits  This is a string of characters representing the DTMF digits
+                 to be sent to the channel.  Valid characters are
+                 "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
+                 'F', if you want to Flash the channel (if supported by the
+                 channel), or 'w' to add a 500 millisecond pause to the DTMF
+                 sequence.
+  \param between This is the number of milliseconds to wait in between each
+                 DTMF digit.  If zero milliseconds is specified, then the
+                 default value of 100 will be used.
 */
 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between);