diff options
author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-03 01:01:25 +0000 |
---|---|---|
committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-03 01:01:25 +0000 |
commit | 25c62b5de7f04cdfc80c98ef14cb5647143e14d5 (patch) | |
tree | 81df3f713ae7c89cfb8228bf411a5e9eb673293a /apps/app_db.c | |
parent | f2d5a34825f4be8a1e128e086b0d4b0dc181f80c (diff) |
Add XML documentation for:
- WaitForSilence()
- WaitForNoise()
- WaitForRing()
- IVRDemo()
- DBDel()
- DBDeltree()
(issue #13699)
Reported by: snuffy
Patches:
bug13699_20081016.diff uploaded by snuffy (license 35)
(With minor changes)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153747 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps/app_db.c')
-rw-r--r-- | apps/app_db.c | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/apps/app_db.c b/apps/app_db.c index f141209e9..72b604680 100644 --- a/apps/app_db.c +++ b/apps/app_db.c @@ -39,23 +39,43 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/astdb.h" #include "asterisk/lock.h" -/*! \todo XXX Remove this application after 1.4 is relased */ -static char *d_descrip = -" DBdel(family/key): This application will delete a key from the Asterisk\n" -"database.\n" -" This application has been DEPRECATED in favor of the DB_DELETE function.\n"; - -static char *dt_descrip = -" DBdeltree(family[/keytree]): This application will delete a family or keytree\n" -"from the Asterisk database\n"; +/*** DOCUMENTATION + <application name="DBdel" language="en_US"> + <synopsis> + Delete a key from the asterisk database. + </synopsis> + <syntax argsep="/"> + <parameter name="family" required="true" /> + <parameter name="key" required="true" /> + </syntax> + <description> + <para>This application will delete a <replaceable>key</replaceable> from the Asterisk + database.</para> + <note><para>This application has been DEPRECATED in favor of the DB_DELETE function.</para></note> + </description> + <see-also> + <ref type="function">DB_DELETE</ref> + </see-also> + </application> + <application name="DBdeltree" language="en_US"> + <synopsis> + Delete a family or keytree from the asterisk database. + </synopsis> + <syntax argsep="/"> + <parameter name="family" required="true" /> + <parameter name="keytree" /> + </syntax> + <description> + <para>This application will delete a <replaceable>family</replaceable> or <replaceable>keytree</replaceable> + from the Asterisk database.</para> + </description> + </application> + ***/ +/*! \todo XXX Remove this application after 1.4 is relased */ static char *d_app = "DBdel"; static char *dt_app = "DBdeltree"; -static char *d_synopsis = "Delete a key from the database"; -static char *dt_synopsis = "Delete a family or keytree from the database"; - - static int deltree_exec(struct ast_channel *chan, void *data) { char *argv, *family, *keytree; @@ -130,8 +150,8 @@ static int load_module(void) { int retval; - retval = ast_register_application(d_app, del_exec, d_synopsis, d_descrip); - retval |= ast_register_application(dt_app, deltree_exec, dt_synopsis, dt_descrip); + retval = ast_register_application_xml(d_app, del_exec); + retval |= ast_register_application_xml(dt_app, deltree_exec); return retval; } |