kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 03:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation replication issues

Browse Source 
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
This commit is contained in:
Kinsey Moore
2013-08-01 17:07:52 +00:00
parent 5601b0f50c
commit 03090a88ba
33 changed files with 303 additions and 779 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
main/manager_bridges.c
View File

@@ -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>
***/