aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_skel.c
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
commitb1f91b97d2085cc845d0f57bd9907de50c995105 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_skel.c
parentc5d084051f21e943fcbcc347fc80b166885f298d (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_skel.c')
-rw-r--r--apps/app_skel.c34
1 files changed, 29 insertions, 5 deletions
diff --git a/apps/app_skel.c b/apps/app_skel.c
index 44bf152aa..338a32f8a 100644
--- a/apps/app_skel.c
+++ b/apps/app_skel.c
@@ -44,11 +44,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/lock.h"
#include "asterisk/app.h"
+/*** DOCUMENTATION
+ <application name="Skel" language="en_US">
+ <synopsis>
+ Simple one line explaination.
+ </synopsis>
+ <syntax>
+ <parameter name="dummy" required="true"/>
+ <parameter name="options">
+ <optionlist>
+ <option name="a">
+ <para>Option A.</para>
+ </option>
+ <option name="b">
+ <para>Option B.</para>
+ </option>
+ <option name="c">
+ <para>Option C.</para>
+ </option>
+ </optionlist>
+ </parameter>
+ </syntax>
+ <description>
+ <para>This application is a template to build other applications from.
+ It shows you the basic structure to create your own Asterisk applications.</para>
+ </description>
+ </application>
+ ***/
+
static char *app = "Skel";
-static char *synopsis =
-"Skeleton application.";
-static char *descrip = "This application is a template to build other applications from.\n"
- " It shows you the basic structure to create your own Asterisk applications.\n";
enum {
OPTION_A = (1 << 0),
@@ -122,7 +146,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ast_register_application(app, app_exec, synopsis, descrip) ?
+ return ast_register_application_xml(app, app_exec) ?
AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
}