summaryrefslogtreecommitdiff
path: root/include/asterisk/xmldoc.h
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 /include/asterisk/xmldoc.h
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 'include/asterisk/xmldoc.h')
-rw-r--r--include/asterisk/xmldoc.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/asterisk/xmldoc.h b/include/asterisk/xmldoc.h
index d781e8043..c876b46da 100644
--- a/include/asterisk/xmldoc.h
+++ b/include/asterisk/xmldoc.h
@@ -23,6 +23,13 @@
#include "asterisk/xml.h"
+/*! \brief From where the documentation come from, this structure is useful for
+ * use it inside application/functions/manager actions structure. */
+enum ast_doc_src {
+ AST_XML_DOC, /*!< From XML documentation */
+ AST_STATIC_DOC /*!< From application/function registration */
+};
+
#ifdef AST_XML_DOCS
/*!