summaryrefslogtreecommitdiff
path: root/main/db.c
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2009-05-22 17:52:35 +0000
committerEliel C. Sardanons <eliels@gmail.com>2009-05-22 17:52:35 +0000
commit2c882626a0ebbfe6dfe9d89cb495765a218e978d (patch)
treee1c6ca80d913c0e0aa3166a40d7b8e4461cd62d1 /main/db.c
parent3c7db3b7e84c8dbf1f561f8e37b23add5332d456 (diff)
Implement a new element in AstXML for AMI actions documentation.
A new xml element was created to manage the AMI actions documentation, using AstXML. To register a manager action using XML documentation it is now possible using ast_manager_register_xml(). The CLI command 'manager show command' can be used to show the parsed documentation. Example manager xml documentation: <manager name="ami action name" language="en_US"> <synopsis> AMI action synopsis. </synopsis> <syntax> <xi:include xpointer="xpointer(...)" /> <-- for ActionID <parameter name="header1" required="true"> <para>Description</para> </parameter> ... </syntax> <description> <para>AMI action description</para> </description> <see-also> ... </see-also> </manager> git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196308 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main/db.c')
-rw-r--r--main/db.c60
1 files changed, 56 insertions, 4 deletions
diff --git a/main/db.c b/main/db.c
index 6528aa246..244288a19 100644
--- a/main/db.c
+++ b/main/db.c
@@ -48,6 +48,58 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/manager.h"
#include "db1-ast/include/db.h"
+/*** DOCUMENTATION
+ <manager name="DBGet" language="en_US">
+ <synopsis>
+ Get DB Entry.
+ </synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+ <parameter name="Family" required="true" />
+ <parameter name="Key" required="true" />
+ </syntax>
+ <description>
+ </description>
+ </manager>
+ <manager name="DBPut" language="en_US">
+ <synopsis>
+ Put DB entry.
+ </synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+ <parameter name="Family" required="true" />
+ <parameter name="Key" required="true" />
+ <parameter name="Val" />
+ </syntax>
+ <description>
+ </description>
+ </manager>
+ <manager name="DBDel" language="en_US">
+ <synopsis>
+ Delete DB entry.
+ </synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+ <parameter name="Family" required="true" />
+ <parameter name="Key" required="true" />
+ </syntax>
+ <description>
+ </description>
+ </manager>
+ <manager name="DBDelTree" language="en_US">
+ <synopsis>
+ Delete DB Tree.
+ </synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+ <parameter name="Family" required="true" />
+ <parameter name="Key" />
+ </syntax>
+ <description>
+ </description>
+ </manager>
+ ***/
+
static DB *astdb;
AST_MUTEX_DEFINE_STATIC(dblock);
@@ -666,9 +718,9 @@ int astdb_init(void)
{
dbinit();
ast_cli_register_multiple(cli_database, ARRAY_LEN(cli_database));
- ast_manager_register("DBGet", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_dbget, "Get DB Entry");
- ast_manager_register("DBPut", EVENT_FLAG_SYSTEM, manager_dbput, "Put DB Entry");
- ast_manager_register("DBDel", EVENT_FLAG_SYSTEM, manager_dbdel, "Delete DB Entry");
- ast_manager_register("DBDelTree", EVENT_FLAG_SYSTEM, manager_dbdeltree, "Delete DB Tree");
+ ast_manager_register_xml("DBGet", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_dbget);
+ ast_manager_register_xml("DBPut", EVENT_FLAG_SYSTEM, manager_dbput);
+ ast_manager_register_xml("DBDel", EVENT_FLAG_SYSTEM, manager_dbdel);
+ ast_manager_register_xml("DBDelTree", EVENT_FLAG_SYSTEM, manager_dbdeltree);
return 0;
}