[svn-commits] rmudgett: branch 12 r401420 - /branches/12/res/res_parking.c

[SVN commits to the Digium repositories]

Author: rmudgett
Date: Tue Oct 22 11:26:20 2013
New Revision: 401420

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=401420
Log:
res_parking: Update XML documention for DTMF features after parking timeout.

* Updated the XML documentation to indicate that the parkedcalltransfers,
parkedcallreparking, parkedcallhangup, and parkedcallrecording
configuration options also apply to parking timeouts.

(issue ASTERISK-22542)
Reported by: Kevin Harwell

Review: https://reviewboard.asterisk.org/r/2942/

Modified:
    branches/12/res/res_parking.c

Modified: branches/12/res/res_parking.c
URL: http://svnview.digium.com/svn/asterisk/branches/12/res/res_parking.c?view=diff&rev=401420&r1=401419&r2=401420
==============================================================================
--- branches/12/res/res_parking.c (original)
+++ branches/12/res/res_parking.c Tue Oct 22 11:26:20 2013
@@ -98,8 +98,11 @@
 						<note><para>When parking times out and the channel returns to the dial plan, the following variables are set:
 						</para></note>
 						<variablelist>
+							<variable name="PARKING_SPACE">
+								<para>extension that the call was parked in prior to timing out.</para>
+							</variable>
 							<variable name="PARKINGSLOT">
-								<para>extension that the call was parked in prior to timing out.</para>
+								<para>Deprecated.  Use <variable>PARKING_SPACE</variable> instead.</para>
 							</variable>
 							<variable name="PARKEDLOT">
 								<para>name of the lot that the call was parked in prior to timing out.</para>
@@ -107,6 +110,9 @@
 							<variable name="PARKER">
 								<para>The device that parked the call</para>
 							</variable>
+							<variable name="PARKER_FLAT">
+								<para>The flat version of <variable>PARKER</variable></para>
+							</variable>
 						</variablelist>
 					</description>
 				</configOption>
@@ -131,33 +137,33 @@
 					<description>
 						<enumlist>
 							<enum name="no"><para>Apply to neither side.</para></enum>
-							<enum name="caller"><para>Apply to only to the caller picking up the parked call.</para></enum>
-							<enum name="callee"><para>Apply to only to the parked call being picked up.</para></enum>
-							<enum name="both"><para>Apply to both the caller and the callee.</para></enum>
+							<enum name="caller"><para>Apply only to the call connecting with the call coming out of the parking lot.</para></enum>
+							<enum name="callee"><para>Apply only to the call coming out of the parking lot.</para></enum>
+							<enum name="both"><para>Apply to both sides.</para></enum>
 						</enumlist>
 						<note><para>If courtesy tone is not specified then this option will be ignored.</para></note>
 					</description>
 				</configOption>
 				<configOption name="parkedcalltransfers" default="no">
-					<synopsis>Apply the DTMF transfer features to the caller and/or callee when parked calls are picked up.</synopsis>
+					<synopsis>Who to apply the DTMF transfer features to when parked calls are picked up or timeout.</synopsis>
 					<description>
 						<xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
 					</description>
 				</configOption>
 				<configOption name="parkedcallreparking" default="no">
-					<synopsis>Apply the DTMF parking feature to the caller and/or callee when parked calls are picked up.</synopsis>
+					<synopsis>Who to apply the DTMF parking feature to when parked calls are picked up or timeout.</synopsis>
 					<description>
 						<xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
 					</description>
 				</configOption>
 				<configOption name="parkedcallhangup" default="no">
-					<synopsis>Apply the DTMF Hangup feature to the caller and/or callee when parked calls are picked up.</synopsis>
+					<synopsis>Who to apply the DTMF hangup feature to when parked calls are picked up or timeout.</synopsis>
 					<description>
 						<xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
 					</description>
 				</configOption>
 				<configOption name="parkedcallrecording" default="no">
-					<synopsis>Apply the DTMF recording features to the caller and/or callee when parked calls are picked up</synopsis>
+					<synopsis>Who to apply the DTMF MixMonitor recording feature to when parked calls are picked up or timeout.</synopsis>
 					<description>
 						<xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
 					</description>