diff options
author | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
---|---|---|
committer | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
commit | 2ffae5745d6d68f1599f4dfbf0ead131cf5acc32 (patch) | |
tree | 1304cf10595e850a33e2dbb2458a2819751bc1ce /main/manager.c | |
parent | 3805e2ae4d654a24f7c98fc6f41dcec81d02670e (diff) |
Add some additional documentation for core AMI events
This patch adds some basic documentation for a number of modules. This
includes core source files in Asterisk (those in main), as well as
chan_agent, chan_dahdi, chan_local, sig_analog, and sig_pri. The DTD
has also been updated to allow referencing of AMI commands.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369905 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main/manager.c')
-rw-r--r-- | main/manager.c | 33 |
1 files changed, 32 insertions, 1 deletions
diff --git a/main/manager.c b/main/manager.c index 3eb113322..d70ac6d15 100644 --- a/main/manager.c +++ b/main/manager.c @@ -476,7 +476,34 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <replaceable>Extension</replaceable>/<replaceable>Context</replaceable>/<replaceable>Priority</replaceable> or <replaceable>Application</replaceable>/<replaceable>Data</replaceable></para> </description> + <see-also> + <ref type="managerEvent">OriginateResponse</ref> + </see-also> </manager> + <managerEvent language="en_US" name="OriginateResponse"> + <managerEventInstance class="EVENT_FLAG_CALL"> + <synopsis>Raised in response to an Originate command.</synopsis> + <syntax> + <parameter name="ActionID" required="false"/> + <parameter name="Resonse"> + <enumlist> + <enum name="Failure"/> + <enum name="Success"/> + </enumlist> + </parameter> + <parameter name="Channel"/> + <parameter name="Context"/> + <parameter name="Exten"/> + <parameter name="Reason"/> + <parameter name="Uniqueid"/> + <parameter name="CallerIDNum"/> + <parameter name="CallerIDName"/> + </syntax> + <see-also> + <ref type="manager">Originate</ref> + </see-also> + </managerEventInstance> + </managerEvent> <manager name="Command" language="en_US"> <synopsis> Execute Asterisk CLI Command. @@ -5535,7 +5562,11 @@ static int manager_state_cb(char *context, char *exten, struct ast_state_cb_info } ast_get_hint(hint, sizeof(hint), NULL, 0, NULL, context, exten); - + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an extension state has changed.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_CALL, "ExtensionStatus", "Exten: %s\r\nContext: %s\r\nHint: %s\r\nStatus: %d\r\n", exten, context, hint, state); return 0; } |