mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 03:20:57 +00:00
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
This commit is contained in:
@@ -36,13 +36,28 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
||||
#include "asterisk/lock.h"
|
||||
#include "asterisk/app.h"
|
||||
|
||||
static char *synopsis = "Soft Hangup Application";
|
||||
/*** DOCUMENTATION
|
||||
<application name="SoftHangup" language="en_US">
|
||||
<synopsis>
|
||||
Hangs up the requested channel.
|
||||
</synopsis>
|
||||
<syntax>
|
||||
<parameter name="Technology/Resource" required="true" />
|
||||
<parameter name="options">
|
||||
<optionlist>
|
||||
<option name="a">
|
||||
<para>Hang up all channels on a specified device instead of a single resource</para>
|
||||
</option>
|
||||
</optionlist>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<para>Hangs up the requested channel. If there are no channels to
|
||||
hangup, the application will report it.</para>
|
||||
</description>
|
||||
</application>
|
||||
|
||||
static char *desc = " SoftHangup(Technology/resource[,options]):\n"
|
||||
"Hangs up the requested channel. If there are no channels to hangup,\n"
|
||||
"the application will report it.\n"
|
||||
" Options:\n"
|
||||
" 'a' - hang up all channels on a specified device instead of a single resource\n";
|
||||
***/
|
||||
|
||||
static char *app = "SoftHangup";
|
||||
|
||||
@@ -114,7 +129,7 @@ static int unload_module(void)
|
||||
|
||||
static int load_module(void)
|
||||
{
|
||||
return ast_register_application(app, softhangup_exec, synopsis, desc);
|
||||
return ast_register_application_xml(app, softhangup_exec);
|
||||
}
|
||||
|
||||
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Hangs up the requested channel");
|
||||
|
Reference in New Issue
Block a user