From: Richard Mudgett Date: Tue, 4 Dec 2012 22:31:02 +0000 (+0000) Subject: confbridge: Update online XML documentation. X-Git-Tag: 10.12.0-rc1~14 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4e4b27beeac1bb2d37f7f104d78145679e160d36;p=thirdparty%2Fasterisk.git confbridge: Update online XML documentation. git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/10@377212 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c index 22e1cd0e22..6fe80ec628 100644 --- a/apps/app_confbridge.c +++ b/apps/app_confbridge.c @@ -60,34 +60,48 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/test.h" /*** DOCUMENTATION - - - Conference bridge application. - - - - The conference number - - - The bridge profile name from confbridge.conf. When left blank, a dynamically built bridge profile created by the CONFBRIDGE dialplan function is searched for on the channel and used. If no dynamic profile is present, the 'default_bridge' profile found in confbridge.conf is used. - It is important to note that while user profiles may be unique for each participant, mixing bridge profiles on a single conference is _NOT_ recommended and will produce undefined results. - - - The user profile name from confbridge.conf. When left blank, a dynamically built user profile created by the CONFBRIDGE dialplan function is searched for on the channel and used. If no dynamic profile is present, the 'default_user' profile found in confbridge.conf is used. - - - The name of the DTMF menu in confbridge.conf to be applied to this channel. No menu is applied by default if this option is left blank. - - - - Enters the user into a specified conference bridge. The user can exit the conference by hangup or DTMF menu option. - - - ConfBridge - CONFBRIDGE - CONFBRIDGE_INFO - - + + + Conference bridge application. + + + + Name of the conference bridge. You are not limited to just + numbers. + + + The bridge profile name from confbridge.conf. When left blank, + a dynamically built bridge profile created by the CONFBRIDGE dialplan + function is searched for on the channel and used. If no dynamic + profile is present, the 'default_bridge' profile found in + confbridge.conf is used. + It is important to note that while user profiles may be unique + for each participant, mixing bridge profiles on a single conference + is _NOT_ recommended and will produce undefined results. + + + The user profile name from confbridge.conf. When left blank, + a dynamically built user profile created by the CONFBRIDGE dialplan + function is searched for on the channel and used. If no dynamic + profile is present, the 'default_user' profile found in + confbridge.conf is used. + + + The name of the DTMF menu in confbridge.conf to be applied to + this channel. No menu is applied by default if this option is left + blank. + + + + Enters the user into a specified conference bridge. The user can + exit the conference by hangup or DTMF menu option. + + + ConfBridge + CONFBRIDGE + CONFBRIDGE_INFO + + Set a custom dynamic bridge and user profile on a channel for the ConfBridge application using the same options defined in confbridge.conf. @@ -96,7 +110,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Type refers to which type of profile the option belongs too. Type can be bridge or user. - + Option refers to confbridge.conf option that is being set dynamically on this channel.