summaryrefslogtreecommitdiff
path: root/include/asterisk/agi.h
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2008-11-12 00:17:43 +0000
committerEliel C. Sardanons <eliels@gmail.com>2008-11-12 00:17:43 +0000
commit6f31fed83f91018f70d453afd2003150587b8856 (patch)
treeea3966ab1c52341565ff036f510bb7ecddaef0b4 /include/asterisk/agi.h
parentf50966c16acf6105f02e41820acf223505d2963d (diff)
Implement AGI XML documentation parsing functions.
A new <agi> element is used to describe the XML documentation. We have the usual synopsis,syntax,description and seealso for AGI commands. The CLI 'agi show commands' command was changed to show all the documentation se ctions. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@156051 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/agi.h')
-rw-r--r--include/asterisk/agi.h21
1 files changed, 13 insertions, 8 deletions
diff --git a/include/asterisk/agi.h b/include/asterisk/agi.h
index 609e98815..48de8c954 100644
--- a/include/asterisk/agi.h
+++ b/include/asterisk/agi.h
@@ -38,20 +38,25 @@ typedef struct agi_state {
} AGI;
typedef struct agi_command {
- /* Null terminated list of the words of the command */
- char *cmda[AST_MAX_CMD_LEN];
- /* Handler for the command (channel, AGI state, # of arguments, argument list).
+ char *cmda[AST_MAX_CMD_LEN]; /*!< Null terminated list of the words of the command */
+ /*! Handler for the command (channel, AGI state, # of arguments, argument list).
Returns RESULT_SHOWUSAGE for improper arguments */
int (*handler)(struct ast_channel *chan, AGI *agi, int argc, char *argv[]);
- /* Summary of the command (< 60 characters) */
+ /*! Summary of the command (< 60 characters) */
char *summary;
- /* Detailed usage information */
+ /*! Detailed usage information */
char *usage;
- /* Does this application run dead */
+ /*! Does this application run dead */
int dead;
- /* Pointer to module that registered the agi command */
+ /*! AGI command syntax description */
+ char *syntax;
+ /*! See also content */
+ char *seealso;
+ /*! Where the documentation come from. */
+ enum ast_doc_src docsrc;
+ /*! Pointer to module that registered the agi command */
struct ast_module *mod;
- /* Linked list pointer */
+ /*! Linked list pointer */
AST_LIST_ENTRY(agi_command) list;
} agi_command;