diff options
| author | Kinsey Moore <kmoore@digium.com> | 2013-08-01 17:07:52 +0000 |
|---|---|---|
| committer | Kinsey Moore <kmoore@digium.com> | 2013-08-01 17:07:52 +0000 |
| commit | 03090a88bab15b94843e3850df68b37ff8948b54 (patch) | |
| tree | b32e51b384941143881c82dbb1a2d90e8de3536f /main/manager_bridges.c | |
| parent | 5601b0f50cf30fd05c97a44ff7e18c20f58fc947 (diff) | |
Fix documentation replication issues
This prevents XML documentation duplication by expanding channel and
bridge snapshot tags into channel and bridge snapshot parameter sets
with a given prefix or defaulting to no prefix. This also prevents
documentation from becoming fractured and out of date by keeping all
variations of the documentation in template form such that it only
needs to be updated once and keeps maintenance to a minimum.
Review: https://reviewboard.asterisk.org/r/2708/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@395985 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main/manager_bridges.c')
| -rw-r--r-- | main/manager_bridges.c | 36 |
1 files changed, 8 insertions, 28 deletions
diff --git a/main/manager_bridges.c b/main/manager_bridges.c index c791e63f3..5d831b5b4 100644 --- a/main/manager_bridges.c +++ b/main/manager_bridges.c @@ -40,18 +40,7 @@ static struct stasis_message_router *bridge_state_router; <managerEventInstance class="EVENT_FLAG_CALL"> <synopsis>Raised when a bridge is created.</synopsis> <syntax> - <parameter name="BridgeUniqueid"> - <para>The unique identifier of the bridge</para> - </parameter> - <parameter name="BridgeType"> - <para>The type of bridge</para> - </parameter> - <parameter name="BridgeTechnology"> - <para>Technology in use by the bridge</para> - </parameter> - <parameter name="BridgeNumChannels"> - <para>Number of channels in the bridge</para> - </parameter> + <bridge_snapshot/> </syntax> </managerEventInstance> </managerEvent> @@ -59,7 +48,7 @@ static struct stasis_message_router *bridge_state_router; <managerEventInstance class="EVENT_FLAG_CALL"> <synopsis>Raised when a bridge is destroyed.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='BridgeCreate']/managerEventInstance/syntax/parameter)" /> + <bridge_snapshot/> </syntax> </managerEventInstance> </managerEvent> @@ -67,10 +56,8 @@ static struct stasis_message_router *bridge_state_router; <managerEventInstance class="EVENT_FLAG_CALL"> <synopsis>Raised when a channel enters a bridge.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='BridgeCreate']/managerEventInstance/syntax/parameter)" /> - <parameter name="Uniqueid"> - <para>The uniqueid of the channel entering the bridge</para> - </parameter> + <bridge_snapshot/> + <channel_snapshot/> </syntax> </managerEventInstance> </managerEvent> @@ -78,10 +65,8 @@ static struct stasis_message_router *bridge_state_router; <managerEventInstance class="EVENT_FLAG_CALL"> <synopsis>Raised when a channel leaves a bridge.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='BridgeCreate']/managerEventInstance/syntax/parameter)" /> - <parameter name="Uniqueid"> - <para>The uniqueid of the channel leaving the bridge</para> - </parameter> + <bridge_snapshot/> + <channel_snapshot/> </syntax> </managerEventInstance> </managerEvent> @@ -246,13 +231,8 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub, <managerEventInstance> <synopsis>Raised when two bridges are merged.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='BridgeCreate']/managerEventInstance/syntax/parameter)" /> - <parameter name="BridgeUniqueidFrom"> - <para>The uniqueid of the bridge being dissolved in the merge</para> - </parameter> - <parameter name="BridgeTypeFrom"> - <para>The type of bridge that is being dissolved in the merge</para> - </parameter> + <bridge_snapshot/> + <bridge_snapshot prefix="From"/> </syntax> </managerEventInstance> ***/ |