[asterisk-commits] eliel: branch group/appdocsxml r145385 - /team/group/appdocsxml/funcs/

[SVN commits to the Asterisk project]

Author: eliel
Date: Wed Oct  1 10:18:55 2008
New Revision: 145385

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145385
Log:
Introduce the VOLUME() function XML documentation.

Modified:
    team/group/appdocsxml/funcs/func_volume.c

Modified: team/group/appdocsxml/funcs/func_volume.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_volume.c?view=diff&rev=145385&r1=145384&r2=145385
==============================================================================
--- team/group/appdocsxml/funcs/func_volume.c (original)
+++ team/group/appdocsxml/funcs/func_volume.c Wed Oct  1 10:18:55 2008
@@ -35,6 +35,26 @@
 #include "asterisk/pbx.h"
 #include "asterisk/utils.h"
 #include "asterisk/audiohook.h"
+
+/*** DOCUMENTATION
+	<function name="VOLUME" language="en_US">
+		<synopsis>
+			Set the TX or RX volume of a channel.
+		</synopsis>
+		<syntax>
+			<parameter name="direction" required="true">
+				<para>Must be <literal>TX</literal> or <literal>RX</literal>.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>The VOLUME function can be used to increase or decrease the <literal>tx</literal> or
+			<literal>rx</literal> gain of any channel.</para>
+			<para>For example:</para>
+			<para>Set(VOLUME(TX)=3)</para>
+			<para>Set(VOLUME(RX)=2)</para>
+		</description>
+	</function>
+ ***/
 
 struct volume_information {
 	struct ast_audiohook audiohook;
@@ -137,13 +157,6 @@
 
 static struct ast_custom_function volume_function = {
 	.name = "VOLUME",
-	.synopsis = "Set the TX or RX volume of a channel",
-	.syntax = "VOLUME(TX|RX)",
-	.desc =
-	"  The VOLUME function can be used to increase or decrease the tx or\n"
-	"rx gain of any channel.  For example:\n"
-	"  Set(VOLUME(TX)=3)\n"
-	"  Set(VOLUME(RX)=2)\n",
 	.write = volume_write,
 };