kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-21 09:10:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

ConfBridge: Fix channel parameter documentation

Browse Source 
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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/11@406217 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Kinsey Moore
2014-01-22 19:31:12 +00:00
parent 9f8388bb14
commit 5e6a9d0461
1 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
apps/app_confbridge.c
View File

@@ -182,7 +182,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
<parameter name="Conference" required="true" /> <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> </syntax>
<description> <description>
</description> </description>
@@ -194,7 +196,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
<parameter name="Conference" required="true" /> <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> </syntax>
<description> <description>
</description> </description>
@@ -264,7 +268,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
<parameter name="Conference" required="true" /> <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> </syntax>
<description> <description>
</description> </description>
@@ -2421,7 +2427,10 @@ static char *handle_cli_confbridge_mute(struct ast_cli_entry *e, int cmd, struct
e->command = "confbridge mute"; e->command = "confbridge mute";
e->usage = e->usage =
"Usage: confbridge mute <conference> <channel>\n" "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; return NULL;
case CLI_GENERATE: case CLI_GENERATE:
if (a->pos == 2) { if (a->pos == 2) {
@@ -2448,7 +2457,10 @@ static char *handle_cli_confbridge_unmute(struct ast_cli_entry *e, int cmd, stru
e->command = "confbridge unmute"; e->command = "confbridge unmute";
e->usage = e->usage =
"Usage: confbridge unmute <conference> <channel>\n" "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; return NULL;
case CLI_GENERATE: case CLI_GENERATE:
if (a->pos == 2) { if (a->pos == 2) {