diff options
author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-05 19:17:32 +0000 |
---|---|---|
committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-05 19:17:32 +0000 |
commit | a979b0107de96d72364fa3f266a1f6c2fc658e42 (patch) | |
tree | b1fba954e0e3cd6b201cb6db286d6310f2d4ae03 /apps | |
parent | f109162c7d529a492431adc63a634dd03565d48a (diff) |
Add TestClient() and TestServer() applications XML
documentation.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@154801 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps')
-rw-r--r-- | apps/app_test.c | 47 |
1 files changed, 35 insertions, 12 deletions
diff --git a/apps/app_test.c b/apps/app_test.c index e873777e4..205571ffe 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; } |