diff options
author | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
commit | 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch) | |
tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_verbose.c | |
parent | 1fef0f63bbbde9530837995c8790b839f73b74e7 (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: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_verbose.c')
-rw-r--r-- | apps/app_verbose.c | 49 |
1 files changed, 38 insertions, 11 deletions
diff --git a/apps/app_verbose.c b/apps/app_verbose.c index 525cc1c55..b4c6a6384 100644 --- a/apps/app_verbose.c +++ b/apps/app_verbose.c @@ -33,16 +33,43 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/channel.h" static char *app_verbose = "Verbose"; -static char *verbose_synopsis = "Send arbitrary text to verbose output"; -static char *verbose_descrip = -"Verbose([<level>,]<message>)\n" -" level must be an integer value. If not specified, defaults to 0.\n"; - static char *app_log = "Log"; -static char *log_synopsis = "Send arbitrary text to a selected log level"; -static char *log_descrip = -"Log(<level>,<message>)\n" -" level must be one of ERROR, WARNING, NOTICE, DEBUG, VERBOSE, DTMF\n"; + +/*** DOCUMENTATION + <application name="Verbose" language="en_US"> + <synopsis> + Send arbitrary text to verbose output. + </synopsis> + <syntax> + <parameter name="level"> + <para>Must be an integer value. If not specified, defaults to 0.</para> + </parameter> + <parameter name="message" required="true"> + <para>Output text message.</para> + </parameter> + </syntax> + <description> + <para>Sends an arbitrary text message to verbose output.</para> + </description> + </application> + <application name="Log" language="en_US"> + <synopsis> + Send arbitrary text to a selected log level. + </synopsis> + <syntax> + <parameter name="level"> + <para>Level must be one of <literal>ERROR</literal>, <literal>WARNING</literal>, <literal>NOTICE</literal>, + <literal>DEBUG</literal>, <literal>VERBOSE</literal> or <literal>DTMF</literal>.</para> + </parameter> + <parameter name="message" required="true"> + <para>Output text message.</para> + </parameter> + </syntax> + <description> + <para>Sends an arbitrary text message to a selected log level.</para> + </description> + </application> + ***/ static int verbose_exec(struct ast_channel *chan, void *data) @@ -149,8 +176,8 @@ static int load_module(void) { int res; - res = ast_register_application(app_log, log_exec, log_synopsis, log_descrip); - res |= ast_register_application(app_verbose, verbose_exec, verbose_synopsis, verbose_descrip); + res = ast_register_application_xml(app_log, log_exec); + res |= ast_register_application_xml(app_verbose, verbose_exec); return res; } |