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

[SVN commits to the Asterisk project]

Author: eliel
Date: Thu Oct  2 07:05:59 2008
New Revision: 145742

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145742
Log:
Introduce CALLERID() and CALLERPRES() functions XML documentation.

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

Modified: team/group/appdocsxml/funcs/func_callerid.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_callerid.c?view=diff&rev=145742&r1=145741&r2=145742
==============================================================================
--- team/group/appdocsxml/funcs/func_callerid.c (original)
+++ team/group/appdocsxml/funcs/func_callerid.c Thu Oct  2 07:05:59 2008
@@ -31,6 +31,49 @@
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 #include "asterisk/callerid.h"
+
+/*** DOCUMENTATION
+	<function name="CALLERID" language="en_US">
+		<synopsis>
+			Gets or sets Caller*ID data on the channel.
+		</synopsis>
+		<syntax>
+			<parameter name="datatype" required="true">
+				<para>The allowable datatypes are:
+				<literal>all</literal>, <literal>name</literal>,
+				<literal>num</literal>,	<literal>ANI</literal>,
+				<literal>DNID</literal>, <literal>RDNIS</literal>,
+				<literal>pres</literal> and <literal>ton</literal></para>
+			</parameter>
+			<parameter name="CID">
+				<para>Optional Caller*ID</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Gets or sets Caller*ID data on the channel. Uses channel callerid by default or optional
+			callerid, if specified.</para>
+		</description>
+	</function>
+	<function name="CALLERPRES" language="en_US">
+		<synopsis>
+			Gets or sets Caller*ID presentation on the channel.
+		</synopsis>
+		<syntax />
+		<description>
+			<para>Gets or sets Caller*ID presentation on the channel. The following values
+			are valid:</para>
+			<para><literal>allowed_not_screened</literal>    : Presentation Allowed, Not Screened</para>
+			<para><literal>allowed_passed_screen</literal>   : Presentation Allowed, Passed Screen</para>
+			<para><literal>allowed_failed_screen</literal>   : Presentation Allowed, Failed Screen</para>
+			<para><literal>allowed</literal>                 : Presentation Allowed, Network Number</para>
+			<para><literal>prohib_not_screened</literal>     : Presentation Prohibited, Not Screened</para>
+			<para><literal>prohib_passed_screen</literal>    : Presentation Prohibited, Passed Screen</para>
+			<para><literal>prohib_failed_screen</literal>    : Presentation Prohibited, Failed Screen</para>
+			<para><literal>prohib</literal>                  : Presentation Prohibited, Network Number</para>
+			<para><literal>unavailable</literal>             : Number Unavailable</para>
+		</description>
+	</function>
+ ***/
 
 static int callerpres_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 {
@@ -185,33 +228,12 @@
 
 static struct ast_custom_function callerid_function = {
 	.name = "CALLERID",
-	.synopsis = "Gets or sets Caller*ID data on the channel.",
-	.syntax = "CALLERID(datatype[,<optional-CID>])",
-	.desc =
-		"Gets or sets Caller*ID data on the channel.  The allowable datatypes\n"
-		"are \"all\", \"name\", \"num\", \"ANI\", \"DNID\", \"RDNIS\", \"pres\",\n"
-		"and \"ton\".\n"
-		"Uses channel callerid by default or optional callerid, if specified.\n",
 	.read = callerid_read,
 	.write = callerid_write,
 };
 
 static struct ast_custom_function callerpres_function = {
 	.name = "CALLERPRES",
-	.synopsis = "Gets or sets Caller*ID presentation on the channel.",
-	.syntax = "CALLERPRES()",
-	.desc =
-"Gets or sets Caller*ID presentation on the channel.  The following values\n"
-"are valid:\n"
-"      allowed_not_screened    : Presentation Allowed, Not Screened\n"
-"      allowed_passed_screen   : Presentation Allowed, Passed Screen\n" 
-"      allowed_failed_screen   : Presentation Allowed, Failed Screen\n" 
-"      allowed                 : Presentation Allowed, Network Number\n"
-"      prohib_not_screened     : Presentation Prohibited, Not Screened\n" 
-"      prohib_passed_screen    : Presentation Prohibited, Passed Screen\n"
-"      prohib_failed_screen    : Presentation Prohibited, Failed Screen\n"
-"      prohib                  : Presentation Prohibited, Network Number\n"
-"      unavailable             : Number Unavailable\n",
 	.read = callerpres_read,
 	.write = callerpres_write,
 };