Clean up documentation

This patch cleans up documentation in func_channel for the following items:
* rtpsource
* secure_signaling
* secure_media

(closes issue ASTERISK-20969)
Reported by: snuffy
patches:
  func_chan-update.diff uploaded by snuffy (License 5024)

git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.8@394980 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/funcs/func_channel.c b/funcs/func_channel.c
index a5fff75c5cc10664b481f4ebb310eede3293cbbf..7bca6bf7f99007d9823d84e7922f99096929714d 100644 (file)
--- a/funcs/func_channel.c
+++ b/funcs/func_channel.c
@@ -20,7 +20,7 @@
  *
  * \author Kevin P. Fleming <kpfleming@digium.com>
  * \author Ben Winslow
- * 
+ *
  * \ingroup functions
  */
 
@@ -221,16 +221,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                                                <para>     <literal>audio</literal>             Get audio destination</para>
                                                <para>     <literal>video</literal>             Get video destination</para>
                                                <para>     <literal>text</literal>              Get text destination</para>
+                                               <para>   Defaults to <literal>audio</literal> if unspecified.</para>
+                                       </enum>
+                                       <enum name="rtpsource">
+                                               <para>R/O Get source RTP destination information.</para>
+                                               <para>   This option takes one additional argument:</para>
+                                               <para>    Argument 1:</para>
+                                               <para>     <literal>audio</literal>             Get audio destination</para>
+                                               <para>     <literal>video</literal>             Get video destination</para>
+                                               <para>     <literal>text</literal>              Get text destination</para>
+                                               <para>   Defaults to <literal>audio</literal> if unspecified.</para>
                                        </enum>
                                </enumlist>
                                <para><emphasis>chan_iax2</emphasis> provides the following additional options:</para>
                                <enumlist>
+                                       <enum name="osptoken">
+                                               <para>R/O Get the peer's osptoken.</para>
+                                       </enum>
                                        <enum name="peerip">
                                                <para>R/O Get the peer's ip address.</para>
                                        </enum>
                                        <enum name="peername">
                                                <para>R/O Get the peer's username.</para>
                                        </enum>
+                                       <enum name="secure_signaling">
+                                               <para>R/O Get the if the IAX channel is secured.</para>
+                                       </enum>
+                                       <enum name="secure_media">
+                                               <para>R/O Get the if the IAX channel is secured.</para>
+                                       </enum>
                                </enumlist>
                                <para><emphasis>chan_dahdi</emphasis> provides the following additional options:</para>
                                <enumlist>
@@ -467,7 +486,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);
@@ -482,7 +501,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 (chan->zone) {