diff options
| author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-02 06:24:53 +0000 |
|---|---|---|
| committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-02 06:24:53 +0000 |
| commit | 2d6e969e7c81afb0b050691b85f2bc74ca84ae62 (patch) | |
| tree | d4c1aa16ec3d088b22e2d303ae4368a78b3b1fff /channels/chan_iax2.c | |
| parent | c04a0f396ba5ae668da9a18d18a9431c88bb6700 (diff) | |
Add IAX2Provision() application XML documentation.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153582 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'channels/chan_iax2.c')
| -rw-r--r-- | channels/chan_iax2.c | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c index 8ad6b5de4..adf4fa6f4 100644 --- a/channels/chan_iax2.c +++ b/channels/chan_iax2.c @@ -94,6 +94,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "iax2-provision.h" #include "jitterbuf.h" +/*** DOCUMENTATION + <application name="IAX2Provision" language="en_US"> + <synopsis> + Provision a calling IAXy with a given template. + </synopsis> + <syntax> + <parameter name="template"> + <para>If not specified, defaults to <literal>default</literal>.</para> + </parameter> + </syntax> + <description> + <para>Provisions the calling IAXy (assuming the calling entity is in fact an IAXy) with the + given <replaceable>template</replaceable>. Returns <literal>-1</literal> on error + or <literal>0</literal> on success.</para> + </description> + </application> + ***/ + /* Define SCHED_MULTITHREADED to run the scheduler in a special multithreaded mode. */ #define SCHED_MULTITHREADED @@ -10016,11 +10034,6 @@ static int iax2_provision(struct sockaddr_in *end, int sockfd, char *dest, const } static char *papp = "IAX2Provision"; -static char *psyn = "Provision a calling IAXy with a given template"; -static char *pdescrip = -" IAX2Provision([template]): Provisions the calling IAXy (assuming\n" -"the calling entity is in fact an IAXy) with the given template or\n" -"default if one is not specified. Returns -1 on error or 0 on success.\n"; /*! iax2provision \ingroup applications @@ -12420,7 +12433,7 @@ static int load_module(void) ast_cli_register_multiple(cli_iax2, sizeof(cli_iax2) / sizeof(struct ast_cli_entry)); - ast_register_application(papp, iax2_prov_app, psyn, pdescrip); + ast_register_application_xml(papp, iax2_prov_app); ast_manager_register( "IAXpeers", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peers, "List IAX Peers" ); ast_manager_register( "IAXpeerlist", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peer_list, "List IAX Peers" ); |