manager: Add <see-also> tags to relate Bridge related events,actions, and apps
authorMatt Jordan <mjordan@digium.com>
Sun, 14 Aug 2016 01:15:58 +0000 (20:15 -0500)
committerMatt Jordan <mjordan@digium.com>
Mon, 15 Aug 2016 12:41:06 +0000 (07:41 -0500)
Change-Id: I67e6b79fa3102e494b5fe6cc7510472249080e85

main/bridge.c
main/features.c
main/manager_bridges.c

index 68ac24b..e92875d 100644 (file)
                <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>
                <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>
                <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>
 ***/
 
index 4062e96..0af5a78 100644 (file)
@@ -202,6 +202,11 @@ ASTERISK_REGISTER_FILE()
                                </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_REGISTER_FILE()
                <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>
  ***/
 
index 2069d50..b6aaa55 100644 (file)
@@ -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>
  ***/