diff options
| author | Kinsey Moore <kmoore@digium.com> | 2014-01-22 19:36:23 +0000 |
|---|---|---|
| committer | Kinsey Moore <kmoore@digium.com> | 2014-01-22 19:36:23 +0000 |
| commit | 3e6c4a6f8964474cb16442a91120b6c3a7d697c8 (patch) | |
| tree | d300687e7e0d2e89f4848988f3a1be9ebffec5f2 /apps/app_confbridge.c | |
| parent | 0fbffdb3b29b8d4e19c105f88dd7ea6371c728af (diff) | |
ConfBridge: Fix channel parameter documentation
Confbridge AMI and CLI commands for mute, unmute, and setting the
single video source can accept channel prefixes in lieu of a full
channel name, but documentation states only that it is required and is
a channel name. This corrects the documentation.
(closes issue PQ-1397)
Reported by: Steve Pitts
........
Merged revisions 406217 from http://svn.asterisk.org/svn/asterisk/branches/11
........
Merged revisions 406223 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@406224 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_confbridge.c')
| -rw-r--r-- | apps/app_confbridge.c | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c index e02405984..4f854aa1a 100644 --- a/apps/app_confbridge.c +++ b/apps/app_confbridge.c @@ -208,7 +208,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <syntax> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <parameter name="Conference" required="true" /> - <parameter name="Channel" required="true" /> + <parameter name="Channel" required="true"> + <para>If this parameter is not a complete channel name, the first channel with this prefix will be used.</para> + </parameter> </syntax> <description> </description> @@ -220,7 +222,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <syntax> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <parameter name="Conference" required="true" /> - <parameter name="Channel" required="true" /> + <parameter name="Channel" required="true"> + <para>If this parameter is not a complete channel name, the first channel with this prefix will be used.</para> + </parameter> </syntax> <description> </description> @@ -290,7 +294,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <syntax> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <parameter name="Conference" required="true" /> - <parameter name="Channel" required="true" /> + <parameter name="Channel" required="true"> + <para>If this parameter is not a complete channel name, the first channel with this prefix will be used.</para> + </parameter> </syntax> <description> </description> @@ -2501,7 +2507,10 @@ static char *handle_cli_confbridge_mute(struct ast_cli_entry *e, int cmd, struct e->command = "confbridge mute"; e->usage = "Usage: confbridge mute <conference> <channel>\n" - " Mute a channel in a conference.\n"; + " Mute a channel in a conference.\n" + " If the specified channel is a prefix,\n" + " the action will be taken on the first\n" + " matching channel.\n"; return NULL; case CLI_GENERATE: if (a->pos == 2) { @@ -2528,7 +2537,10 @@ static char *handle_cli_confbridge_unmute(struct ast_cli_entry *e, int cmd, stru e->command = "confbridge unmute"; e->usage = "Usage: confbridge unmute <conference> <channel>\n" - " Unmute a channel in a conference.\n"; + " Unmute a channel in a conference.\n" + " If the specified channel is a prefix,\n" + " the action will be taken on the first\n" + " matching channel.\n"; return NULL; case CLI_GENERATE: if (a->pos == 2) { |