[asterisk-commits] mmichelson: branch mmichelson/features_config_docs r391060 - /team/mmichelson...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Sun Jun  9 17:24:34 2013
New Revision: 391060

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391060
Log:
Add descriptions to configuration options that require further explanation.


Modified:
    team/mmichelson/features_config_docs/main/features_config.c

Modified: team/mmichelson/features_config_docs/main/features_config.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/features_config_docs/main/features_config.c?view=diff&rev=391060&r1=391059&r2=391060
==============================================================================
--- team/mmichelson/features_config_docs/main/features_config.c (original)
+++ team/mmichelson/features_config_docs/main/features_config.c Sun Jun  9 17:24:34 2013
@@ -47,12 +47,22 @@
 				</configOption>
 				<configOption name="atxferdropcall" default="no">
 					<synopsis>Hang up the call entirely if the attended transfer fails</synopsis>
+					<description>
+						<para>When this option is set to <literal>no</literal>, then Asterisk will attempt to
+						re-call the transferrer if the call to the transfer target fails. If the call to the
+						transferrer fails, then Asterisk will wait <replaceable>atxferloopdelay</replaceable>
+						milliseconds and then attempt to dial the transfer target again. This process will
+						repeat until <replaceable>atxfercallbackretries</replaceable> attempts to re-call 
+						the transferrer have occurred.</para>
+					</description>
 				</configOption>
 				<configOption name="atxferloopdelay" default="10000">
 					<synopsis>Milliseconds to wait between attempts to re-dial transfer destination</synopsis>
+					<see-also><ref type="configOption">atxferdropcall</ref></see-also>
 				</configOption>
 				<configOption name="atxfercallbackretries" default="2">
 					<synopsis>Number of times to re-attempt dialing a transfer destination</synopsis>
+					<see-also><ref type="configOption">atxferdropcall</ref></see-also>
 				</configOption>
 				<configOption name="xfersound" default="beep">
 					<synopsis>Sound to play to a transferee when a transfer completes</synopsis>
@@ -62,15 +72,39 @@
 				</configOption>
 				<configOption name="atxferabort" default="*1">
 					<synopsis>Digits to dial to abort an attended transfer attempt</synopsis>
+					<description>
+						<para>This option is only available to the transferrer during an attended
+						transfer operation. Aborting a transfer results in all parties being hung
+						up</para>
+					</description>
 				</configOption>
 				<configOption name="atxfercomplete" default="*2">
 					<synopsis>Digits to dial to complete an attended transfer</synopsis>
+					<description>
+						<para>This option is only available to the transferrer during an attended
+						transfer operation. Completing the transfer with a DTMF sequence is functionally
+						equivalent to hanging up the transferrer channel during an attended transfer. The
+						result is that the transfer target and transferees are bridged.</para>
+					</description>
 				</configOption>
 				<configOption name="atxferthreeway" default="*3">
 					<synopsis>Digits to dial to change an attended transfer into a three-way call</synopsis>
+					<description>
+						<para>This option is only available to the transferrer during an attended
+						transfer operation. Pressing this DTMF sequence will result in the transferrer,
+						the transferees, and the transfer target all joining the bridge that the transferrer
+						and transferees were originally in.</para>
+					</description>
 				</configOption>
 				<configOption name="pickupexten" default="*8">
 					<synopsis>Digits used for picking up ringing calls</synopsis>
+					<description>
+						<para>In order for the pickup attempt to be successful, the party attempting to
+						pick up the call must either have a <replaceable>namedpickupgroup</replaceable> in
+						common with a ringing party's <replaceable>namedcallgroup</replaceable> or must
+						have a <replaceable>pickupgroup</replaceable> in common with a ringing party's
+						<replaceable>callgroup</replaceable>.</para>
+					</description>
 				</configOption>
 				<configOption name="pickupsound">
 					<synopsis>Sound to play to picker when a call is picked up</synopsis>