diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
commit | b1f91b97d2085cc845d0f57bd9907de50c995105 (patch) | |
tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_setcallerid.c | |
parent | c5d084051f21e943fcbcc347fc80b166885f298d (diff) |
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format. Currently, a new format is available for
applications and dialplan functions. A good number of conversions to the new format
are also included.
For more information, see the following message to asterisk-dev:
http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps/app_setcallerid.c')
-rw-r--r-- | apps/app_setcallerid.c | 65 |
1 files changed, 45 insertions, 20 deletions
diff --git a/apps/app_setcallerid.c b/apps/app_setcallerid.c index f1c9df3cb..6592249b4 100644 --- a/apps/app_setcallerid.c +++ b/apps/app_setcallerid.c @@ -38,26 +38,51 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/image.h" #include "asterisk/callerid.h" -static char *app2 = "SetCallerPres"; - -static char *synopsis2 = "Set CallerID Presentation"; +/*** 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 *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 char *app2 = "SetCallerPres"; static int setcallerid_pres_exec(struct ast_channel *chan, void *data) { @@ -91,7 +116,7 @@ static int unload_module(void) 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"); |