summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAutomerge script <automerge@asterisk.org>2012-12-04 23:19:30 +0000
committerAutomerge script <automerge@asterisk.org>2012-12-04 23:19:30 +0000
commit4acb2070f21883d1da40322df6b5d18fd727f5a6 (patch)
tree9d1a9e3e7716774ce5b8f11976f000f24c6770b7
parent2158005bdb7e4822497ae1ccd50adc1da9a3410b (diff)
Merged revisions 377214 via svnmerge from
file:///srv/subversion/repos/asterisk/trunk ................ r377214 | rmudgett | 2012-12-04 16:34:05 -0600 (Tue, 04 Dec 2012) | 8 lines confbridge: Update online XML documentation. ........ Merged revisions 377212 from http://svn.asterisk.org/svn/asterisk/branches/10 ........ Merged revisions 377213 from http://svn.asterisk.org/svn/asterisk/branches/11 ................ git-svn-id: https://origsvn.digium.com/svn/asterisk/team/mmichelson/threadpool@377220 65c4cc65-6c06-0410-ace0-fbb531ad65f3
-rw-r--r--apps/app_confbridge.c72
1 files changed, 43 insertions, 29 deletions
diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c
index 216f7e7d4..d5eabb87e 100644
--- a/apps/app_confbridge.c
+++ b/apps/app_confbridge.c
@@ -69,34 +69,48 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/test.h"
/*** DOCUMENTATION
- <application name="ConfBridge" language="en_US">
- <synopsis>
- Conference bridge application.
- </synopsis>
- <syntax>
- <parameter name="confno">
- <para>The conference number</para>
- </parameter>
- <parameter name="bridge_profile">
- <para>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. </para>
- <para>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.</para>
- </parameter>
- <parameter name="user_profile">
- <para>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.</para>
- </parameter>
- <parameter name="menu">
- <para>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.</para>
- </parameter>
- </syntax>
- <description>
- <para>Enters the user into a specified conference bridge. The user can exit the conference by hangup or DTMF menu option.</para>
- </description>
- <see-also>
- <ref type="application">ConfBridge</ref>
- <ref type="function">CONFBRIDGE</ref>
- <ref type="function">CONFBRIDGE_INFO</ref>
- </see-also>
- </application>
+ <application name="ConfBridge" language="en_US">
+ <synopsis>
+ Conference bridge application.
+ </synopsis>
+ <syntax>
+ <parameter name="conference" required="true">
+ <para>Name of the conference bridge. You are not limited to just
+ numbers.</para>
+ </parameter>
+ <parameter name="bridge_profile">
+ <para>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. </para>
+ <para>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.</para>
+ </parameter>
+ <parameter name="user_profile">
+ <para>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.</para>
+ </parameter>
+ <parameter name="menu">
+ <para>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.</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Enters the user into a specified conference bridge. The user can
+ exit the conference by hangup or DTMF menu option.</para>
+ </description>
+ <see-also>
+ <ref type="application">ConfBridge</ref>
+ <ref type="function">CONFBRIDGE</ref>
+ <ref type="function">CONFBRIDGE_INFO</ref>
+ </see-also>
+ </application>
<function name="CONFBRIDGE" language="en_US">
<synopsis>
Set a custom dynamic bridge and user profile on a channel for the ConfBridge application using the same options defined in confbridge.conf.
@@ -105,7 +119,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<parameter name="type" required="true">
<para>Type refers to which type of profile the option belongs too. Type can be <literal>bridge</literal> or <literal>user</literal>.</para>
</parameter>
- <parameter name="option" required="true">
+ <parameter name="option" required="true">
<para>Option refers to <filename>confbridge.conf</filename> option that is being set dynamically on this channel.</para>
</parameter>
</syntax>