[svn-commits] mmichelson: branch mmichelson/features_config_docs r391056 - /team/mmichelson...

SVN commits to the Digium repositories svn-commits at lists.digium.com
Sun Jun 9 16:53:24 CDT 2013


Author: mmichelson
Date: Sun Jun  9 16:53:22 2013
New Revision: 391056

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391056
Log:
Add synopses for global feature options.

This also changes the FEATURE dialplan function to point to those
synopses. There is currently something incorrect in these pointers
because the CLI command to print the help for FEATURE does not include
the synopses as would be expected.


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=391056&r1=391055&r2=391056
==============================================================================
--- team/mmichelson/features_config_docs/main/features_config.c (original)
+++ team/mmichelson/features_config_docs/main/features_config.c Sun Jun  9 16:53:22 2013
@@ -34,64 +34,49 @@
 				<synopsis>
 				</synopsis>
 				<configOption name="featuredigittimeout">
-					<synopsis>
-					</synopsis>
+					<synopsis>Milliseconds allowed between digits when entering a feature code.</synopsis>
 				</configOption>
 				<configOption name="courtesytone">
-					<synopsis>
-					</synopsis>
+					<synopsis>Sound to play when automon or automixmon is activated</synopsis>
 				</configOption>
 				<configOption name="transferdigittimeout">
-					<synopsis>
-					</synopsis>
+					<synopsis>Milliseconds allowed between digits when dialing a transfer destination</synopsis>
 				</configOption>
 				<configOption name="atxfernoanswertimeout">
-					<synopsis>
-					</synopsis>
+					<synopsis>Milliseconds to wait for transfer destination to answer</synopsis>
 				</configOption>
 				<configOption name="atxferdropcall">
-					<synopsis>
-					</synopsis>
+					<synopsis>Hang up the call entirely if the attended transfer fails</synopsis>
 				</configOption>
 				<configOption name="atxferloopdelay">
-					<synopsis>
-					</synopsis>
+					<synopsis>Milliseconds to wait between attempts to re-dial transfer destination</synopsis>
 				</configOption>
 				<configOption name="atxfercallbackretries">
-					<synopsis>
-					</synopsis>
+					<synopsis>Number of times to re-attempt dialing a transfer destination</synopsis>
 				</configOption>
 				<configOption name="xfersound">
-					<synopsis>
-					</synopsis>
+					<synopsis>Sound to play to a transferee when a transfer completes</synopsis>
 				</configOption>
 				<configOption name="xferfailsound">
-					<synopsis>
-					</synopsis>
+					<synopsis>Sound to play to a transferee when a transfer fails</synopsis>
 				</configOption>
 				<configOption name="atxferabort">
-					<synopsis>
-					</synopsis>
+					<synopsis>Digits to dial to abort an attended transfer attempt</synopsis>
 				</configOption>
 				<configOption name="atxfercomplete">
-					<synopsis>
-					</synopsis>
+					<synopsis>Digits to dial to complete an attended transfer</synopsis>
 				</configOption>
 				<configOption name="atxferthreeway">
-					<synopsis>
-					</synopsis>
+					<synopsis>Digits to dial to change an attended transfer into a three-way call</synopsis>
 				</configOption>
 				<configOption name="pickupexten">
-					<synopsis>
-					</synopsis>
+					<synopsis>Digits used for picking up ringing calls</synopsis>
 				</configOption>
 				<configOption name="pickupsound">
-					<synopsis>
-					</synopsis>
+					<synopsis>Sound to play to picker when a call is picked up</synopsis>
 				</configOption>
 				<configOption name="pickupfailsound">
-					<synopsis>
-					</synopsis>
+					<synopsis>Sound to play to picker when a call cannot be picked up</synopsis>
 				</configOption>
 			</configObject>
 			<configObject name="featuremap">
@@ -237,21 +222,21 @@
 				<para>The allowed values are:</para>
 				<enumlist>
 					<enum name="inherit"><para>Inherit feature settings made in FEATURE or FEATUREMAP to child channels.</para></enum>
-					<enum name="featuredigittimeout"><para>Milliseconds allowed between digits when entering a feature code.</para></enum>
-					<enum name="transferdigittimeout"><para>Milliseconds allowed between digits when dialing a transfer destination</para></enum>
-					<enum name="atxfernoanswertimeout"><para>Milliseconds to wait for transfer destination to answer</para></enum>
-					<enum name="atxferdropcall"><para>Hang up the call entirely if the attended transfer fails</para></enum>
-					<enum name="atxferloopdelay"><para>Milliseconds to wait between attempts to re-dial transfer destination</para></enum>
-					<enum name="atxfercallbackretries"><para>Number of times to re-attempt dialing a transfer destination</para></enum>
-					<enum name="xfersound"><para>Sound to play to a transferee when a transfer completes</para></enum>
-					<enum name="xferfailsound"><para>Sound to play to a transferee when a transfer fails</para></enum>
-					<enum name="atxferabort"><para>Digits to dial to abort an attended transfer attempt</para></enum>
-					<enum name="atxfercomplete"><para>Digits to dial to complete an attended transfer</para></enum>
-					<enum name="atxferthreeway"><para>Digits to dial to change an attended transfer into a three-way call</para></enum>
-					<enum name="pickupexten"><para>Digits used for picking up ringing calls</para></enum>
-					<enum name="pickupsound"><para>Sound to play to picker when a call is picked up</para></enum>
-					<enum name="pickupfailsound"><para>Sound to play to picker when a call cannot be picked up</para></enum>
-					<enum name="courtesytone"><para>Sound to play when automon or automixmon is activated</para></enum>
+					<enum name="featuredigittimeout"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='featuredigittimeout']/synopsis)" /></enum>
+					<enum name="transferdigittimeout"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='transferdigittimeout']/synopsis)" /></enum>
+					<enum name="atxfernoanswertimeout"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxfernoanswertimeout']/synopsis)" /></enum>
+					<enum name="atxferdropcall"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxferdropcall']/synopsis)" /></enum>
+					<enum name="atxferloopdelay"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxferloopdelay']/synopsis)" /></enum>
+					<enum name="atxfercallbackretries"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxfercallbackretries']/synopsis)" /></enum>
+					<enum name="xfersound"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='xfersound']/synopsis)" /></enum>
+					<enum name="xferfailsound"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='xferfailsound']/synopsis)" /></enum>
+					<enum name="atxferabort"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxferabort']/synopsis)" /></enum>
+					<enum name="atxfercomplete"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxfercomplete']/synopsis)" /></enum>
+					<enum name="atxferthreeway"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='atxferthreeway']/synopsis)" /></enum>
+					<enum name="pickupexten"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='pickupexten']/synopsis)" /></enum>
+					<enum name="pickupsound"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='pickupsound']/synopsis)" /></enum>
+					<enum name="pickupfailsound"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='pickupfailsound']/synopsis)" /></enum>
+					<enum name="courtesytone"><xi:include xpointer="xpointer(/docs/configInfo[@name='features']/configFile[@name='features.conf']/configObject[@name='globals']/configOption[@name='courtesytone']/synopsis)" /></enum>
 				</enumlist>
 			</parameter>
 		</syntax>




More information about the svn-commits mailing list