[svn-commits] oej: branch oej/mutestream-trunk r215037 - /team/oej/mutestream-trunk/res/

[SVN commits to the Digium repositories]

Author: oej
Date: Mon Aug 31 13:30:29 2009
New Revision: 215037

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=215037
Log:
Adding XML docs

Modified:
    team/oej/mutestream-trunk/res/res_mutestream.c

Modified: team/oej/mutestream-trunk/res/res_mutestream.c
URL: http://svn.asterisk.org/svn-view/asterisk/team/oej/mutestream-trunk/res/res_mutestream.c?view=diff&rev=215037&r1=215036&r2=215037
==============================================================================
--- team/oej/mutestream-trunk/res/res_mutestream.c (original)
+++ team/oej/mutestream-trunk/res/res_mutestream.c Mon Aug 31 13:30:29 2009
@@ -47,6 +47,22 @@
 #include "asterisk/audiohook.h"
 #include "asterisk/manager.h"
 
+/*** DOCUMENTATION
+	<function name="MUTESTREAM" language="en_US">
+		<synopsis>
+			Muting streams in the channel
+		</synopsis>
+		<syntax>
+			<parameter name="direction" required="true">
+				<para>Must be <literal>in</literal>, <literal>out</literal> or <literal>all</literal>.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>The MUTESTREAM function can be used to mute inbound (to the PBX) or outbound audio in a call.
+			</para>
+		</description>
+	</function>
+ ***/
 
 
 /*! Our own datastore */
@@ -210,10 +226,6 @@
 static struct ast_custom_function mute_function = {
         .name = "MUTESTREAM",
         .write = func_mute_write,
-	.synopsis = "Muting streams in the channel",
-	.syntax = "MUTESTREAM(in|out|all) = true|false",
-	.desc = "The mute function mutes either inbound (to the PBX) or outbound"
-		"audio. \"all\" indicates both directions",
 };
 
 static int manager_mutestream(struct mansession *s, const struct message *m)