[Asterisk-code-review] features: Update documentation for automon and automixmon (asterisk[18])

[Trevor Peirce]

Trevor Peirce has uploaded this change for review. ( https://gerrit.asterisk.org/c/asterisk/+/18734 )


Change subject: features: Update documentation for automon and automixmon
......................................................................

features: Update documentation for automon and automixmon

The current documentation is out of date and does not reflect actual
behaviour.  This change makes documentation clearer and accurately
reflect the purpose of relevant channel variables.

ASTERISK-30123

Change-Id: I160d0b01fce862477ad55ac1aa708a730473eb6f
---
M main/features_config.c
1 file changed, 15 insertions(+), 11 deletions(-)



  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/34/18734/1

diff --git a/main/features_config.c b/main/features_config.c
index 50ca69b..ac0135a 100644
--- a/main/features_config.c
+++ b/main/features_config.c
@@ -184,30 +184,34 @@
 					</description>
 				</configOption>
 				<configOption name="automon">
-					<synopsis>DTMF sequence to start or stop monitoring a call</synopsis>
+					<synopsis>DTMF sequence to start or stop Monitor on a call</synopsis>
 					<description>
 						<para>This will cause the channel that pressed the DTMF sequence
 						to be monitored by the <literal>Monitor</literal> application. The
 						format for the recording is determined by the <replaceable>TOUCH_MONITOR_FORMAT</replaceable>
 						channel variable. If this variable is not specified, then <literal>wav</literal> is the
 						default. The filename is constructed in the following manner:</para>
-
-						<para>    prefix-timestamp-filename</para>
-
+						<para>    prefix-timestamp-suffix.fmt</para>
 						<para>where prefix is either the value of the <replaceable>TOUCH_MONITOR_PREFIX</replaceable>
 						channel variable or <literal>auto</literal> if the variable is not set. The timestamp
-						is a UNIX timestamp. The filename is either the value of the <replaceable>TOUCH_MONITOR</replaceable>
+						is a UNIX timestamp. The suffix is either the value of the <replaceable>TOUCH_MONITOR</replaceable>
 						channel variable or the callerID of the channels if the variable is not set.</para>
 					</description>
+					<see-also><ref type="configOption">automixmon</ref></see-also>
 				</configOption>
 				<configOption name="automixmon">
-					<synopsis>DTMF sequence to start or stop mixmonitoring a call </synopsis>
+					<synopsis>DTMF sequence to start or stop MixMonitor on a call</synopsis>
 					<description>
-						<para>Operation of the automixmon is similar to the <literal> automon </literal>
-						feature, with the following exceptions:
-							<replaceable>TOUCH_MIXMONITOR</replaceable> is used in place of <replaceable>TOUCH_MONITOR</replaceable>
-							<replaceable>TOUCH_MIXMONITOR_FORMAT</replaceable> is used in place of <replaceable>TOUCH_MIXMONITOR</replaceable>
-							There is no equivalent for <replaceable>TOUCH_MONITOR_PREFIX</replaceable>. <literal>"auto"</literal> is always how the filename begins.</para>
+						<para>This will cause the channel that pressed the DTMF sequence
+						to be monitored by the <literal>MixMonitor</literal> application. The
+						format for the recording is determined by the <replaceable>TOUCH_MIXMONITOR_FORMAT</replaceable>
+						channel variable. If this variable is not specified, then <literal>wav</literal> is the
+						default. The filename is constructed in the following manner:</para>
+						<para>    prefix-timestamp-suffix.fmt</para>
+						<para>where prefix is either the value of the <replaceable>TOUCH_MIXMONITOR_PREFIX</replaceable>
+						channel variable or <literal>auto</literal> if the variable is not set. The timestamp
+						is a UNIX timestamp. The suffix is either the value of the <replaceable>TOUCH_MIXMONITOR</replaceable>
+						channel variable or the callerID of the channels if the variable is not set.</para>
 					</description>
 					<see-also><ref type="configOption">automon</ref></see-also>
 				</configOption>

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18734
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: I160d0b01fce862477ad55ac1aa708a730473eb6f
Gerrit-Change-Number: 18734
Gerrit-PatchSet: 1
Gerrit-Owner: Trevor Peirce <trev at acrovoice.ca>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220703/7692819c/attachment.html>