manager: Add <see-also> tags to relate Bridge related events,actions, and apps

Change-Id: I67e6b79fa3102e494b5fe6cc7510472249080e85
This commit is contained in:
Matt Jordan
2016-08-13 20:15:58 -05:00
parent 8b1e919ae4
commit a93cd39ac1
3 changed files with 72 additions and 0 deletions

View File

@@ -38,6 +38,10 @@
<description> <description>
<para>Returns detailed information about the available bridging technologies.</para> <para>Returns detailed information about the available bridging technologies.</para>
</description> </description>
<see-also>
<ref type="manager">BridgeTechnologySuspend</ref>
<ref type="manager">BridgeTechnologyUnsuspend</ref>
</see-also>
</manager> </manager>
<manager name="BridgeTechnologySuspend" language="en_US"> <manager name="BridgeTechnologySuspend" language="en_US">
<synopsis> <synopsis>
@@ -52,6 +56,10 @@
<description> <description>
<para>Marks a bridging technology as suspended, which prevents subsequently created bridges from using it.</para> <para>Marks a bridging technology as suspended, which prevents subsequently created bridges from using it.</para>
</description> </description>
<see-also>
<ref type="manager">BridgeTechnologySuspend</ref>
<ref type="manager">BridgeTechnologyUnsuspend</ref>
</see-also>
</manager> </manager>
<manager name="BridgeTechnologyUnsuspend" language="en_US"> <manager name="BridgeTechnologyUnsuspend" language="en_US">
<synopsis> <synopsis>
@@ -66,6 +74,10 @@
<description> <description>
<para>Clears a previously suspended bridging technology, which allows subsequently created bridges to use it.</para> <para>Clears a previously suspended bridging technology, which allows subsequently created bridges to use it.</para>
</description> </description>
<see-also>
<ref type="manager">BridgeTechnologyList</ref>
<ref type="manager">BridgeTechnologySuspend</ref>
</see-also>
</manager> </manager>
***/ ***/

View File

@@ -202,6 +202,11 @@ ASTERISK_REGISTER_FILE()
</variable> </variable>
</variablelist> </variablelist>
</description> </description>
<see-also>
<ref type="manager">Bridge</ref>
<ref type="managerEvent">BridgeCreate</ref>
<ref type="managerEvent">BridgeEnter</ref>
</see-also>
</application> </application>
<manager name="Bridge" language="en_US"> <manager name="Bridge" language="en_US">
<synopsis> <synopsis>
@@ -228,6 +233,15 @@ ASTERISK_REGISTER_FILE()
<description> <description>
<para>Bridge together two channels already in the PBX.</para> <para>Bridge together two channels already in the PBX.</para>
</description> </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> </manager>
***/ ***/

View File

@@ -42,6 +42,11 @@ static struct stasis_message_router *bridge_state_router;
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
</syntax> </syntax>
<see-also>
<ref type="managerEvent">BridgeDestroy</ref>
<ref type="managerEvent">BridgeEnter</ref>
<ref type="managerEvent">BridgeLeave</ref>
</see-also>
</managerEventInstance> </managerEventInstance>
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeDestroy"> <managerEvent language="en_US" name="BridgeDestroy">
@@ -50,6 +55,11 @@ static struct stasis_message_router *bridge_state_router;
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
</syntax> </syntax>
<see-also>
<ref type="managerEvent">BridgeCreate</ref>
<ref type="managerEvent">BridgeEnter</ref>
<ref type="managerEvent">BridgeLeave</ref>
</see-also>
</managerEventInstance> </managerEventInstance>
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeEnter"> <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> <para>The uniqueid of the channel being swapped out of the bridge</para>
</parameter> </parameter>
</syntax> </syntax>
<see-also>
<ref type="managerEvent">BridgeCreate</ref>
<ref type="managerEvent">BridgeDestroy</ref>
<ref type="managerEvent">BridgeLeave</ref>
</see-also>
</managerEventInstance> </managerEventInstance>
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeLeave"> <managerEvent language="en_US" name="BridgeLeave">
@@ -71,6 +86,11 @@ static struct stasis_message_router *bridge_state_router;
<bridge_snapshot/> <bridge_snapshot/>
<channel_snapshot/> <channel_snapshot/>
</syntax> </syntax>
<see-also>
<ref type="managerEvent">BridgeCreate</ref>
<ref type="managerEvent">BridgeDestroy</ref>
<ref type="managerEvent">BridgeEnter</ref>
</see-also>
</managerEventInstance> </managerEventInstance>
</managerEvent> </managerEvent>
<manager name="BridgeList" language="en_US"> <manager name="BridgeList" language="en_US">
@@ -86,6 +106,12 @@ static struct stasis_message_router *bridge_state_router;
<description> <description>
<para>Returns a list of bridges, optionally filtering on a bridge type.</para> <para>Returns a list of bridges, optionally filtering on a bridge type.</para>
</description> </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>
<manager name="BridgeInfo" language="en_US"> <manager name="BridgeInfo" language="en_US">
<synopsis> <synopsis>
@@ -100,6 +126,12 @@ static struct stasis_message_router *bridge_state_router;
<description> <description>
<para>Returns detailed information about a bridge and the channels in it.</para> <para>Returns detailed information about a bridge and the channels in it.</para>
</description> </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> <responses>
<list-elements> <list-elements>
<managerEvent language="en_US" name="BridgeInfoChannel"> <managerEvent language="en_US" name="BridgeInfoChannel">
@@ -134,6 +166,13 @@ static struct stasis_message_router *bridge_state_router;
<description> <description>
<para>Deletes the bridge, causing channels to continue or hang up.</para> <para>Deletes the bridge, causing channels to continue or hang up.</para>
</description> </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>
<manager name="BridgeKick" language="en_US"> <manager name="BridgeKick" language="en_US">
<synopsis> <synopsis>
@@ -153,6 +192,13 @@ static struct stasis_message_router *bridge_state_router;
<description> <description>
<para>The channel is removed from the bridge.</para> <para>The channel is removed from the bridge.</para>
</description> </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> </manager>
***/ ***/