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 /res/parking | |
| 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 'res/parking')
| -rw-r--r-- | res/parking/parking_manager.c | 84 |
1 files changed, 8 insertions, 76 deletions
diff --git a/res/parking/parking_manager.c b/res/parking/parking_manager.c index 430d5408a..70fab2852 100644 --- a/res/parking/parking_manager.c +++ b/res/parking/parking_manager.c @@ -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> |