From 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 Mon Sep 17 00:00:00 2001
From: Russell Bryant <russell@russellbryant.com>
Date: Sat, 1 Nov 2008 21:10:07 +0000
Subject: 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
---
 apps/app_dumpchan.c | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

(limited to 'apps/app_dumpchan.c')

diff --git a/apps/app_dumpchan.c b/apps/app_dumpchan.c
index 7742633fd..e2300dbea 100644
--- a/apps/app_dumpchan.c
+++ b/apps/app_dumpchan.c
@@ -36,15 +36,26 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/module.h"
 #include "asterisk/channel.h"
 
-static char *app = "DumpChan";
-static char *synopsis = "Dump Info About The Calling Channel";
-static char *desc =
-	"   DumpChan([<min_verbose_level>])\n"
-	"Displays information on channel and listing of all channel\n"
-	"variables. If min_verbose_level is specified, output is only\n"
-	"displayed when the verbose level is currently set to that number\n"
-	"or greater. \n";
+/*** DOCUMENTATION
+	<application name="DumpChan" language="en_US">
+		<synopsis>
+			Dump Info About The Calling Channel.
+		</synopsis>
+		<syntax>
+			<parameter name="level">
+				<para>Minimun verbose level</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Displays information on channel and listing of all channel
+			variables. If <replaceable>level</replaceable> is specified, output is only
+			displayed when the verbose level is currently set to that number
+			or greater.</para>
+		</description>
+	</application>
+ ***/
 
+static char *app = "DumpChan";
 
 static int serialize_showchan(struct ast_channel *c, char *buf, size_t size)
 {
@@ -156,7 +167,7 @@ static int unload_module(void)
 
 static int load_module(void)
 {
-	return ast_register_application(app, dumpchan_exec, synopsis, desc);
+	return ast_register_application_xml(app, dumpchan_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dump Info About The Calling Channel");
-- 
cgit v1.2.3