From 34e094726e69c5e0a6db6a84b01ded8c97890d68 Mon Sep 17 00:00:00 2001
From: "Eliel C. Sardanons" <eliels@gmail.com>
Date: Wed, 5 Nov 2008 19:17:32 +0000
Subject: [PATCH] Add TestClient() and TestServer() applications XML
documentation.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154801 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
apps/app_test.c | 47 +++++++++++++++++++++++++++++++++++------------
1 file changed, 35 insertions(+), 12 deletions(-)
diff --git a/apps/app_test.c b/apps/app_test.c
index e873777e41..205571ffee 100644
--- a/apps/app_test.c
+++ b/apps/app_test.c
@@ -41,18 +41,41 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
-static char *tests_descrip =
- " TestServer(): Perform test server function and write call report.\n"
- "Results stored in /var/log/asterisk/testreports/<testid>-server.txt";
-static char *tests_app = "TestServer";
-static char *tests_synopsis = "Execute Interface Test Server";
-
-static char *testc_descrip =
- " TestClient(testid): Executes test client with given testid.\n"
- "Results stored in /var/log/asterisk/testreports/<testid>-client.txt";
+/*** DOCUMENTATION
+ <application name="TestServer" language="en_US">
+ <synopsis>
+ Execute Interface Test Server.
+ </synopsis>
+ <syntax />
+ <description>
+ <para>Perform test server function and write call report. Results stored in
+ <filename>/var/log/asterisk/testreports/<testid>-server.txt</filename></para>
+ </description>
+ <see-also>
+ <ref type="application">TestClient</ref>
+ </see-also>
+ </application>
+ <application name="TestClient" language="en_US">
+ <synopsis>
+ Execute Interface Test Client.
+ </synopsis>
+ <syntax>
+ <parameter name="testid" required="true">
+ <para>An ID to identify this test.</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Executes test client with given <replaceable>testid</replaceable>. Results stored in
+ <filename>/var/log/asterisk/testreports/<testid>-client.txt</filename></para>
+ </description>
+ <see-also>
+ <ref type="application">TestServer</ref>
+ </see-also>
+ </application>
+ ***/
+static char *tests_app = "TestServer";
static char *testc_app = "TestClient";
-static char *testc_synopsis = "Execute Interface Test Client";
static int measurenoise(struct ast_channel *chan, int ms, char *who)
{
@@ -458,8 +481,8 @@ static int load_module(void)
{
int res;
- res = ast_register_application(testc_app, testclient_exec, testc_synopsis, testc_descrip);
- res |= ast_register_application(tests_app, testserver_exec, tests_synopsis, tests_descrip);
+ res = ast_register_application_xml(testc_app, testclient_exec);
+ res |= ast_register_application_xml(tests_app, testserver_exec);
return res;
}
--
GitLab