[asterisk-commits] newtonr: branch 12 r419944 - in /branches/12: ./ main/manager.c

[SVN commits to the Asterisk project]

Author: newtonr
Date: Mon Aug  4 14:45:33 2014
New Revision: 419944

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=419944
Log:
Manager - Improve documentation for manager commands Getvar and Setvar.

The documentation for these commands did not make it clear that they could
accept expressions and functions. Modified to make this clear, but tried
not to be overly explicit.

ASTERISK-21178 #close
Reported by: Rusty Newton
Tested by: Rusty Newton

Review: https://reviewboard.asterisk.org/r/3854
........

Merged revisions 419942 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 419943 from http://svn.asterisk.org/svn/asterisk/branches/11

Modified:
    branches/12/   (props changed)
    branches/12/main/manager.c

Propchange: branches/12/
------------------------------------------------------------------------------
Binary property 'branch-11-merged' - no diff available.

Modified: branches/12/main/manager.c
URL: http://svnview.digium.com/svn/asterisk/branches/12/main/manager.c?view=diff&rev=419944&r1=419943&r2=419944
==============================================================================
--- branches/12/main/manager.c (original)
+++ branches/12/main/manager.c Mon Aug  4 14:45:33 2014
@@ -280,7 +280,7 @@
 	</managerEvent>
 	<manager name="Setvar" language="en_US">
 		<synopsis>
-			Set a channel variable.
+			Sets a channel variable or function value.
 		</synopsis>
 		<syntax>
 			<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@@ -288,22 +288,23 @@
 				<para>Channel to set variable for.</para>
 			</parameter>
 			<parameter name="Variable" required="true">
-				<para>Variable name.</para>
+				<para>Variable name, function or expression.</para>
 			</parameter>
 			<parameter name="Value" required="true">
-				<para>Variable value.</para>
+				<para>Variable or function value.</para>
 			</parameter>
 		</syntax>
 		<description>
-			<para>Set a global or local channel variable.</para>
+			<para>This command can be used to set the value of channel variables or dialplan
+			functions.</para>
 			<note>
-				<para>If a channel name is not provided then the variable is global.</para>
+				<para>If a channel name is not provided then the variable is considered global.</para>
 			</note>
 		</description>
 	</manager>
 	<manager name="Getvar" language="en_US">
 		<synopsis>
-			Gets a channel variable.
+			Gets a channel variable or function value.
 		</synopsis>
 		<syntax>
 			<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@@ -311,13 +312,13 @@
 				<para>Channel to read variable from.</para>
 			</parameter>
 			<parameter name="Variable" required="true">
-				<para>Variable name.</para>
+				<para>Variable name, function or expression.</para>
 			</parameter>
 		</syntax>
 		<description>
-			<para>Get the value of a global or local channel variable.</para>
+			<para>Get the value of a channel variable or function return.</para>
 			<note>
-				<para>If a channel name is not provided then the variable is global.</para>
+				<para>If a channel name is not provided then the variable is considered global.</para>
 			</note>
 		</description>
 	</manager>