diff options
| author | Matt Jordan <mjordan@digium.com> | 2016-08-12 13:53:41 -0500 |
|---|---|---|
| committer | Matt Jordan <mjordan@digium.com> | 2016-08-15 07:39:56 -0500 |
| commit | a19f4affe890dba3293f277cc17ab179bce51608 (patch) | |
| tree | 4c36b4885fb75ad9df8d917eb796d0e83defcba8 /main/manager_channels.c | |
| parent | 8b1e919ae46bdab02010a9d25c1c27670b03e87f (diff) | |
manager: Add <see-also> links between related events
This patch adds some see-also references between related AMI events. It
focuses primarily on those events that are guaranteed to come in pairs,
such as DTMFBegin/DTMFEnd, as well as those that occur during the life
cycle of an Asterisk channel, such as Newchannel/Hangup.
Change-Id: Iaab600477052018d0f8c03d0c624c0856e9ff1f3
Diffstat (limited to 'main/manager_channels.c')
| -rw-r--r-- | main/manager_channels.c | 56 |
1 files changed, 54 insertions, 2 deletions
diff --git a/main/manager_channels.c b/main/manager_channels.c index ec1f807dc..ce0e38d9c 100644 --- a/main/manager_channels.c +++ b/main/manager_channels.c @@ -44,6 +44,10 @@ ASTERISK_REGISTER_FILE() <syntax> <channel_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">Newstate</ref> + <ref type="managerEvent">Hangup</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="Newstate"> @@ -52,6 +56,10 @@ ASTERISK_REGISTER_FILE() <syntax> <channel_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">Newchannel</ref> + <ref type="managerEvent">Hangup</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="Hangup"> @@ -66,6 +74,12 @@ ASTERISK_REGISTER_FILE() <para>A description of why the channel was hung up.</para> </parameter> </syntax> + <see-also> + <ref type="managerEvent">Newchannel</ref> + <ref type="managerEvent">SoftHangupRequest</ref> + <ref type="managerEvent">HangupRequest</ref> + <ref type="managerEvent">Newstate</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="HangupRequest"> @@ -75,6 +89,10 @@ ASTERISK_REGISTER_FILE() <channel_snapshot/> <xi:include xpointer="xpointer(/docs/managerEvent[@name='Hangup']/managerEventInstance/syntax/parameter[@name='Cause'])" /> </syntax> + <see-also> + <ref type="managerEvent">SoftHangupRequest</ref> + <ref type="managerEvent">Hangup</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="SoftHangupRequest"> @@ -84,6 +102,10 @@ ASTERISK_REGISTER_FILE() <channel_snapshot/> <xi:include xpointer="xpointer(/docs/managerEvent[@name='Hangup']/managerEventInstance/syntax/parameter[@name='Cause'])" /> </syntax> + <see-also> + <ref type="managerEvent">HangupRequest</ref> + <ref type="managerEvent">Hangup</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="NewExten"> @@ -114,6 +136,9 @@ ASTERISK_REGISTER_FILE() <para>A description of the Caller ID presentation.</para> </parameter> </syntax> + <see-also> + <ref type="function">CALLERID</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="NewAccountCode"> @@ -125,6 +150,9 @@ ASTERISK_REGISTER_FILE() <para>The channel's previous account code</para> </parameter> </syntax> + <see-also> + <ref type="function">CHANNEL</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="DialBegin"> @@ -139,6 +167,9 @@ ASTERISK_REGISTER_FILE() </syntax> <see-also> <ref type="application">Dial</ref> + <ref type="application">Originate</ref> + <ref type="manager">Originate</ref> + <ref type="managerEvent">DialEnd</ref> </see-also> </managerEventInstance> </managerEvent> @@ -219,6 +250,9 @@ ASTERISK_REGISTER_FILE() </syntax> <see-also> <ref type="application">Dial</ref> + <ref type="application">Originate</ref> + <ref type="manager">Originate</ref> + <ref type="managerEvent">DialBegin</ref> </see-also> </managerEventInstance> </managerEvent> @@ -231,6 +265,9 @@ ASTERISK_REGISTER_FILE() <para>The suggested MusicClass, if provided.</para> </parameter> </syntax> + <see-also> + <ref type="managerEvent">Unhold</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="Unhold"> @@ -239,6 +276,9 @@ ASTERISK_REGISTER_FILE() <syntax> <channel_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">Hold</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="ChanSpyStart"> @@ -249,7 +289,8 @@ ASTERISK_REGISTER_FILE() <channel_snapshot prefix="Spyee"/> </syntax> <see-also> - <ref type="application">ChanSpyStop</ref> + <ref type="managerEvent">ChanSpyStop</ref> + <ref type="application">ChanSpy</ref> </see-also> </managerEventInstance> </managerEvent> @@ -261,7 +302,8 @@ ASTERISK_REGISTER_FILE() <channel_snapshot prefix="Spyee"/> </syntax> <see-also> - <ref type="application">ChanSpyStart</ref> + <ref type="managerEvent">ChanSpyStart</ref> + <ref type="application">ChanSpy</ref> </see-also> </managerEventInstance> </managerEvent> @@ -274,6 +316,9 @@ ASTERISK_REGISTER_FILE() <para>Hangup handler parameter string passed to the Gosub application.</para> </parameter> </syntax> + <see-also> + <ref type="function">CHANNEL</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="HangupHandlerPop"> @@ -380,6 +425,7 @@ ASTERISK_REGISTER_FILE() </syntax> <see-also> <ref type="managerEvent">MusicOnHoldStop</ref> + <ref type="application">StartMusicOnHold</ref> <ref type="application">MusicOnHold</ref> </see-also> </managerEventInstance> @@ -856,6 +902,9 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub, </enumlist> </parameter> </syntax> + <see-also> + <ref type="managerEvent">DTMFEnd</ref> + </see-also> </managerEventInstance> ***/ manager_event(EVENT_FLAG_DTMF, "DTMFBegin", @@ -902,6 +951,9 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub, </enumlist> </parameter> </syntax> + <see-also> + <ref type="managerEvent">DTMFBegin</ref> + </see-also> </managerEventInstance> ***/ manager_event(EVENT_FLAG_DTMF, "DTMFEnd", |