[asterisk-commits] eliel: branch group/appdocsxml r148331 - in /team/group/appdocsxml: apps/ doc/

[SVN commits to the Asterisk project]

Author: eliel
Date: Fri Oct 10 14:13:41 2008
New Revision: 148331

URL: http://svn.digium.com/view/asterisk?view=rev&rev=148331
Log:
Introduce SetCallerPres() application XML documentation.
Update DTD to specify the <astcli> element inside <para> elements for CLI commands.

Modified:
    team/group/appdocsxml/apps/app_setcallerid.c
    team/group/appdocsxml/doc/appdocsxml.dtd

Modified: team/group/appdocsxml/apps/app_setcallerid.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_setcallerid.c?view=diff&rev=148331&r1=148330&r2=148331
==============================================================================
--- team/group/appdocsxml/apps/app_setcallerid.c (original)
+++ team/group/appdocsxml/apps/app_setcallerid.c Fri Oct 10 14:13:41 2008
@@ -38,26 +38,51 @@
 #include "asterisk/image.h"
 #include "asterisk/callerid.h"
 
+/*** DOCUMENTATION
+	<application name="SetCallerPres" language="en_US">
+		<synopsis>
+			Set CallerID Presentation.
+		</synopsis>
+		<syntax>
+			<parameter name="presentation" required="true">
+				<enumlist>
+					<enum name="allowed_not_screened">
+						<para>Presentation Allowed, Not Screened.</para>
+					</enum>
+					<enum name="allowed_passed_screen">
+						<para>Presentation Allowed, Passed Screen.</para>
+					</enum>
+					<enum name="allowed_failed_screen">
+						<para>Presentation Allowed, Failed Screen.</para>
+					</enum>
+					<enum name="allowed">
+						<para>Presentation Allowed, Network Number.</para>
+					</enum>
+					<enum name="prohib_not_screened">
+						<para>Presentation Prohibited, Not Screened.</para>
+					</enum>
+					<enum name="prohib_passed_screen">
+						<para>Presentation Prohibited, Passed Screen.</para>
+					</enum>
+					<enum name="prohib_failed_screen">
+						<para>Presentation Prohibited, Failed Screen.</para>
+					</enum>
+					<enum name="prohib">
+						<para>Presentation Prohibited, Network Number.</para>
+					</enum>
+					<enum name="unavailable">
+						<para>Number Unavailable.</para>
+					</enum>
+				</enumlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Set Caller*ID presentation on a call.</para>
+		</description>
+	</application>
+ ***/
+
 static char *app2 = "SetCallerPres";
-
-static char *synopsis2 = "Set CallerID Presentation";
-
-
-static char *descrip2 = 
-"  SetCallerPres(presentation): Set Caller*ID presentation on a call.\n"
-"  Valid presentations are:\n"
-"\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"
-"\n"
-;
 
 static int setcallerid_pres_exec(struct ast_channel *chan, void *data)
 {
@@ -91,7 +116,7 @@
 
 static int load_module(void)
 {
-	return ast_register_application(app2, setcallerid_pres_exec, synopsis2, descrip2);
+	return ast_register_application_xml(app2, setcallerid_pres_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Set CallerID Presentation Application");

Modified: team/group/appdocsxml/doc/appdocsxml.dtd
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/doc/appdocsxml.dtd?view=diff&rev=148331&r1=148330&r2=148331
==============================================================================
--- team/group/appdocsxml/doc/appdocsxml.dtd (original)
+++ team/group/appdocsxml/doc/appdocsxml.dtd Fri Oct 10 14:13:41 2008
@@ -41,12 +41,13 @@
   <!ATTLIST argument multiple (yes|no|true|false) "false">
   <!ATTLIST argument required (yes|no|true|false) "false">
 
-  <!ELEMENT para (#PCDATA|literal|emphasis|filename|directory|replaceable|variable)*>
+  <!ELEMENT para (#PCDATA|astcli|literal|emphasis|filename|directory|replaceable|variable)*>
   <!ELEMENT literal (#PCDATA)>
   <!ELEMENT emphasis (#PCDATA)>
   <!ELEMENT filename (#PCDATA)>
   <!ELEMENT replaceable (#PCDATA)>
   <!ELEMENT directory (#PCDATA)>
+  <!ELEMENT astcli (#PCDATA)>
  
   <!ELEMENT note (para+)>
   <!ELEMENT warning (para+)>