From 232d4fe24f29d4eb831c9fe1948faedd68c39b5d Mon Sep 17 00:00:00 2001 From: Matt Jordan <mjordan@digium.com> Date: Sat, 13 Aug 2016 20:15:58 -0500 Subject: [PATCH] manager: Add <see-also> tags to relate Bridge related events,actions, and apps Change-Id: I67e6b79fa3102e494b5fe6cc7510472249080e85 --- main/bridge.c | 12 +++++++++++ main/features.c | 14 +++++++++++++ main/manager_bridges.c | 46 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+) diff --git a/main/bridge.c b/main/bridge.c index ee5ad735bf..a0f239bf85 100644 --- a/main/bridge.c +++ b/main/bridge.c @@ -38,6 +38,10 @@ <description> <para>Returns detailed information about the available bridging technologies.</para> </description> + <see-also> + <ref type="manager">BridgeTechnologySuspend</ref> + <ref type="manager">BridgeTechnologyUnsuspend</ref> + </see-also> </manager> <manager name="BridgeTechnologySuspend" language="en_US"> <synopsis> @@ -52,6 +56,10 @@ <description> <para>Marks a bridging technology as suspended, which prevents subsequently created bridges from using it.</para> </description> + <see-also> + <ref type="manager">BridgeTechnologySuspend</ref> + <ref type="manager">BridgeTechnologyUnsuspend</ref> + </see-also> </manager> <manager name="BridgeTechnologyUnsuspend" language="en_US"> <synopsis> @@ -66,6 +74,10 @@ <description> <para>Clears a previously suspended bridging technology, which allows subsequently created bridges to use it.</para> </description> + <see-also> + <ref type="manager">BridgeTechnologyList</ref> + <ref type="manager">BridgeTechnologySuspend</ref> + </see-also> </manager> ***/ diff --git a/main/features.c b/main/features.c index 43ec5e1c60..ea4a55baae 100644 --- a/main/features.c +++ b/main/features.c @@ -202,6 +202,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </variable> </variablelist> </description> + <see-also> + <ref type="manager">Bridge</ref> + <ref type="managerEvent">BridgeCreate</ref> + <ref type="managerEvent">BridgeEnter</ref> + </see-also> </application> <manager name="Bridge" language="en_US"> <synopsis> @@ -228,6 +233,15 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Bridge together two channels already in the PBX.</para> </description> + <see-also> + <ref type="application">Bridge</ref> + <ref type="managerEvent">BridgeCreate</ref> + <ref type="managerEvent">BridgeEnter</ref> + <ref type="manager">BridgeDestroy</ref> + <ref type="manager">BridgeInfo</ref> + <ref type="manager">BridgeKick</ref> + <ref type="manager">BridgeList</ref> + </see-also> </manager> ***/ diff --git a/main/manager_bridges.c b/main/manager_bridges.c index e190baa83c..8fcdf13204 100644 --- a/main/manager_bridges.c +++ b/main/manager_bridges.c @@ -42,6 +42,11 @@ static struct stasis_message_router *bridge_state_router; <syntax> <bridge_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">BridgeDestroy</ref> + <ref type="managerEvent">BridgeEnter</ref> + <ref type="managerEvent">BridgeLeave</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="BridgeDestroy"> @@ -50,6 +55,11 @@ static struct stasis_message_router *bridge_state_router; <syntax> <bridge_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">BridgeCreate</ref> + <ref type="managerEvent">BridgeEnter</ref> + <ref type="managerEvent">BridgeLeave</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="BridgeEnter"> @@ -62,6 +72,11 @@ static struct stasis_message_router *bridge_state_router; <para>The uniqueid of the channel being swapped out of the bridge</para> </parameter> </syntax> + <see-also> + <ref type="managerEvent">BridgeCreate</ref> + <ref type="managerEvent">BridgeDestroy</ref> + <ref type="managerEvent">BridgeLeave</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="BridgeLeave"> @@ -71,6 +86,11 @@ static struct stasis_message_router *bridge_state_router; <bridge_snapshot/> <channel_snapshot/> </syntax> + <see-also> + <ref type="managerEvent">BridgeCreate</ref> + <ref type="managerEvent">BridgeDestroy</ref> + <ref type="managerEvent">BridgeEnter</ref> + </see-also> </managerEventInstance> </managerEvent> <manager name="BridgeList" language="en_US"> @@ -86,6 +106,12 @@ static struct stasis_message_router *bridge_state_router; <description> <para>Returns a list of bridges, optionally filtering on a bridge type.</para> </description> + <see-also> + <ref type="manager">Bridge</ref> + <ref type="manager">BridgeDestroy</ref> + <ref type="manager">BridgeInfo</ref> + <ref type="manager">BridgeKick</ref> + </see-also> </manager> <manager name="BridgeInfo" language="en_US"> <synopsis> @@ -100,6 +126,12 @@ static struct stasis_message_router *bridge_state_router; <description> <para>Returns detailed information about a bridge and the channels in it.</para> </description> + <see-also> + <ref type="manager">Bridge</ref> + <ref type="manager">BridgeDestroy</ref> + <ref type="manager">BridgeKick</ref> + <ref type="manager">BridgeList</ref> + </see-also> <responses> <list-elements> <managerEvent language="en_US" name="BridgeInfoChannel"> @@ -134,6 +166,13 @@ static struct stasis_message_router *bridge_state_router; <description> <para>Deletes the bridge, causing channels to continue or hang up.</para> </description> + <see-also> + <ref type="manager">Bridge</ref> + <ref type="manager">BridgeInfo</ref> + <ref type="manager">BridgeKick</ref> + <ref type="manager">BridgeList</ref> + <ref type="managerEvent">BridgeDestroy</ref> + </see-also> </manager> <manager name="BridgeKick" language="en_US"> <synopsis> @@ -153,6 +192,13 @@ static struct stasis_message_router *bridge_state_router; <description> <para>The channel is removed from the bridge.</para> </description> + <see-also> + <ref type="manager">Bridge</ref> + <ref type="manager">BridgeDestroy</ref> + <ref type="manager">BridgeInfo</ref> + <ref type="manager">BridgeList</ref> + <ref type="managerEvent">BridgeLeave</ref> + </see-also> </manager> ***/ -- GitLab