From 88e344d2dfd0850a8b0f8c8beaf3a6db15baacb4 Mon Sep 17 00:00:00 2001 From: Matthew Jordan Date: Sun, 21 Jul 2013 22:09:23 +0000 Subject: [PATCH] Clean up documentation This patch cleans up documentation in func_channel for the following items: * rtpsource * secure_signaling * secure_media * various OOH323 parameters (closes issue ASTERISK-20969) Reported by: snuffy patches: func_chan-update.diff uploaded by snuffy (License 5024) ........ Merged revisions 394980 from http://svn.asterisk.org/svn/asterisk/branches/1.8 ........ Merged revisions 394981 from http://svn.asterisk.org/svn/asterisk/branches/11 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@394982 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- funcs/func_channel.c | 51 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 7 deletions(-) diff --git a/funcs/func_channel.c b/funcs/func_channel.c index 9dd210c4e3..006c0cb99a 100644 --- a/funcs/func_channel.c +++ b/funcs/func_channel.c @@ -20,7 +20,7 @@ * * \author Kevin P. Fleming * \author Ben Winslow - * + * * \ingroup functions */ @@ -260,16 +260,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") audio Get audio destination video Get video destination text Get text destination + Defaults to audio if unspecified. + + + R/O Get source RTP destination information. + This option takes one additional argument: + Argument 1: + audio Get audio destination + video Get video destination + text Get text destination + Defaults to audio if unspecified. chan_iax2 provides the following additional options: + + R/O Get the peer's osptoken. + R/O Get the peer's ip address. R/O Get the peer's username. + + R/O Get the if the IAX channel is secured. + + + R/O Get the if the IAX channel is secured. + chan_dahdi provides the following additional options: @@ -327,17 +346,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") chan_ooh323 provides the following additional options: - Fax Detect [R/W] + R/W Fax Detect Returns 0 or 1 Write yes or no - t38support [R/W] + R/W t38support Returns 0 or 1 Write yes or no - - Returns h323id [R] + + R/0 Returns caller URL + + + R/0 Returns caller h323id + + + R/0 Returns caller dialed digits + + + R/0 Returns caller email + + + R/0 Returns callee email + + + R/0 Returns callee dialed digits + + + R/0 Returns caller URL @@ -553,7 +590,7 @@ static int func_channel_write_real(struct ast_channel *chan, const char *functio #ifdef CHANNEL_TRACE else if (!strcasecmp(data, "trace")) { ast_channel_lock(chan); - if (ast_true(value)) + if (ast_true(value)) ret = ast_channel_trace_enable(chan); else if (ast_false(value)) ret = ast_channel_trace_disable(chan); @@ -568,7 +605,7 @@ static int func_channel_write_real(struct ast_channel *chan, const char *functio struct ast_tone_zone *new_zone; if (!(new_zone = ast_get_indication_zone(value))) { ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", value); - ret = -1; + ret = -1; } else { ast_channel_lock(chan); if (ast_channel_zone(chan)) {