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

[SVN commits to the Asterisk project]

Author: eliel
Date: Wed Oct  1 11:02:00 2008
New Revision: 145432

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

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

Modified: team/group/appdocsxml/funcs/func_vmcount.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_vmcount.c?view=diff&rev=145432&r1=145431&r2=145432
==============================================================================
--- team/group/appdocsxml/funcs/func_vmcount.c (original)
+++ team/group/appdocsxml/funcs/func_vmcount.c Wed Oct  1 11:02:00 2008
@@ -39,6 +39,30 @@
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 
+/*** DOCUMENTATION
+	<function name="VMCOUNT" language="en_US">
+		<synopsis>
+			Count the voicemails in a specified mailbox.
+		</synopsis>
+		<syntax>
+			<parameter name="vmbox" required="true" argsep="@">
+				<argument name="vmbox" required="true" />
+				<argument name="context" required="false">
+					<para>If not specified, defaults to <literal>default</literal>.</para>
+				</argument>
+			</parameter>
+			<parameter name="folder" required="false">
+				<para>If not specified, defaults to <literal>INBOX</literal></para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Count the number of voicemails in a specified mailbox, you could also specify 
+			the <replaceable>context</replaceable> and the mailbox <replaceable>folder</replaceable>.</para>
+			<para>Example: <literal>exten => s,1,Set(foo=${VMCOUNT(125)})</literal></para>
+		</description>
+	</function>
+ ***/
+
 static int acf_vmcount_exec(struct ast_channel *chan, const char *cmd, char *argsstr, char *buf, size_t len)
 {
 	char *context;
@@ -72,11 +96,6 @@
 
 struct ast_custom_function acf_vmcount = {
 	.name = "VMCOUNT",
-	.synopsis = "Counts the voicemail in a specified mailbox",
-	.syntax = "VMCOUNT(vmbox[@context][,folder])",
-	.desc =
-	"  context - defaults to \"default\"\n"
-	"  folder  - defaults to \"INBOX\"\n",
 	.read = acf_vmcount_exec,
 };