kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-18 02:32:36 +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

84
res/parking/parking_manager.c
View File

@@ -96,44 +96,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel is parked.</synopsis>
<syntax>
<parameter name="ParkeeChannel">
</parameter>
<parameter name="ParkeeChannelState">
<para>A numeric code for the channel's current state, related to ChannelStateDesc</para>
</parameter>
<parameter name="ParkeeChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
</parameter>
<parameter name="ParkeeCallerIDNum">
</parameter>
<parameter name="ParkeeCallerIDName">
</parameter>
<parameter name="ParkeeConnectedLineNum">
</parameter>
<parameter name="ParkeeConnectedLineName">
</parameter>
<parameter name="ParkeeAccountCode">
</parameter>
<parameter name="ParkeeContext">
</parameter>
<parameter name="ParkeeExten">
</parameter>
<parameter name="ParkeePriority">
</parameter>
<parameter name="ParkeeUniqueid">
</parameter>
<channel_snapshot prefix="Parkee"/>
<parameter name="ParkerDialString">
<para>Dial String that can be used to call back the parker on ParkingTimeout.</para>
</parameter>
@@ -156,6 +119,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel leaves a parking lot due to reaching the time limit of being parked.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
<channel_snapshot prefix="Parker"/>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ParkedCall']/managerEventInstance/syntax/parameter)" />
</syntax>
</managerEventInstance>
@@ -164,6 +129,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel leaves a parking lot because it hung up without being answered.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
<channel_snapshot prefix="Parker"/>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ParkedCall']/managerEventInstance/syntax/parameter)" />
</syntax>
</managerEventInstance>
@@ -172,45 +139,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel leaves a parking lot because it was retrieved from the parking lot and reconnected.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
<channel_snapshot prefix="Parker"/>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ParkedCall']/managerEventInstance/syntax/parameter)" />
<parameter name="RetrieverChannel">
</parameter>
<parameter name="RetrieverChannelState">
<para>A numeric code for the channel's current state, related to ChannelStateDesc</para>
</parameter>
<parameter name="RetrieverChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
</parameter>
<parameter name="RetrieverCallerIDNum">
</parameter>
<parameter name="RetrieverCallerIDName">
</parameter>
<parameter name="RetrieverConnectedLineNum">
</parameter>
<parameter name="RetrieverConnectedLineName">
</parameter>
<parameter name="RetrieverAccountCode">
</parameter>
<parameter name="RetrieverContext">
</parameter>
<parameter name="RetrieverExten">
</parameter>
<parameter name="RetrieverPriority">
</parameter>
<parameter name="RetrieverUniqueid">
</parameter>
<channel_snapshot prefix="Retriever"/>
</syntax>
</managerEventInstance>
</managerEvent>

10
res/res_agi.c
View File

@@ -940,7 +940,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_AGI">
<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
<channel_snapshot/>
<parameter name="Env">
<para>URL encoded string read from the AsyncAGI server.</para>
</parameter>
@@ -951,7 +951,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_AGI">
<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
<channel_snapshot/>
</syntax>
</managerEventInstance>
</managerEvent>
@@ -959,7 +959,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_AGI">
<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
<channel_snapshot/>
<parameter name="CommandID" required="false">
<para>Optional command ID sent by the AsyncAGI server to identify the command.</para>
</parameter>
@@ -973,7 +973,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_AGI">
<synopsis>Raised when a received AGI command starts processing.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
<channel_snapshot/>
<parameter name="Command">
<para>The AGI command as received from the external source.</para>
</parameter>
@@ -987,7 +987,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<managerEventInstance class="EVENT_FLAG_AGI">
<synopsis>Raised when a received AGI command completes processing.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
<channel_snapshot/>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AGIExecStart']/managerEventInstance/syntax/parameter)" />
<parameter name="ResultCode">
<para>The numeric result code from AGI</para>