summaryrefslogtreecommitdiff
path: root/channels/chan_local.c
diff options
context:
space:
mode:
authorMatthew Jordan <mjordan@digium.com>2012-07-10 22:26:27 +0000
committerMatthew Jordan <mjordan@digium.com>2012-07-10 22:26:27 +0000
commit2ffae5745d6d68f1599f4dfbf0ead131cf5acc32 (patch)
tree1304cf10595e850a33e2dbb2458a2819751bc1ce /channels/chan_local.c
parent3805e2ae4d654a24f7c98fc6f41dcec81d02670e (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 'channels/chan_local.c')
-rw-r--r--channels/chan_local.c25
1 files changed, 25 insertions, 0 deletions
diff --git a/channels/chan_local.c b/channels/chan_local.c
index 5e72a6153..20e46c9aa 100644
--- a/channels/chan_local.c
+++ b/channels/chan_local.c
@@ -955,6 +955,31 @@ static int local_call(struct ast_channel *ast, const char *dest, int timeout)
goto return_cleanup;
}
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when two halves of a Local Channel form a bridge.</synopsis>
+ <syntax>
+ <parameter name="Channel1">
+ <para>The name of the Local Channel half that bridges to another channel.</para>
+ </parameter>
+ <parameter name="Channel2">
+ <para>The name of the Local Channel half that executes the dialplan.</para>
+ </parameter>
+ <parameter name="Context">
+ <para>The context in the dialplan that Channel2 starts in.</para>
+ </parameter>
+ <parameter name="Exten">
+ <para>The extension in the dialplan that Channel2 starts in.</para>
+ </parameter>
+ <parameter name="LocalOptimization">
+ <enumlist>
+ <enum name="Yes"/>
+ <enum name="No"/>
+ </enumlist>
+ </parameter>
+ </syntax>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_CALL, "LocalBridge",
"Channel1: %s\r\n"
"Channel2: %s\r\n"