[Asterisk-code-review] func callerid.c: Update REDIRECTING reason documentation. (asterisk[master])

[Joshua Colp]

Joshua Colp has submitted this change and it was merged.

Change subject: func_callerid.c: Update REDIRECTING reason documentation.
......................................................................


func_callerid.c: Update REDIRECTING reason documentation.

Change-Id: I6e8d39b0711110a4bceafa652e58b30465e28386
---
M funcs/func_callerid.c
1 file changed, 15 insertions(+), 10 deletions(-)

Approvals:
  Kevin Harwell: Looks good to me, but someone else must approve
  Joshua Colp: Looks good to me, approved; Verified



diff --git a/funcs/func_callerid.c b/funcs/func_callerid.c
index dee1977..133e259 100644
--- a/funcs/func_callerid.c
+++ b/funcs/func_callerid.c
@@ -373,22 +373,27 @@
 			fields get/set a combined value for the corresponding
 			<replaceable>...-name-pres</replaceable> and <replaceable>...-num-pres</replaceable>
 			fields.</para>
-			<para>The allowable values for the <replaceable>reason</replaceable>
+			<para>The recognized values for the <replaceable>reason</replaceable>
 			and <replaceable>orig-reason</replaceable> fields are the following:</para>
 			<enumlist>
-				<enum name = "unknown"><para>Unknown</para></enum>
-				<enum name = "cfb"><para>Call Forwarding Busy</para></enum>
-				<enum name = "cfnr"><para>Call Forwarding No Reply</para></enum>
-				<enum name = "unavailable"><para>Callee is Unavailable</para></enum>
-				<enum name = "time_of_day"><para>Time of Day</para></enum>
-				<enum name = "dnd"><para>Do Not Disturb</para></enum>
-				<enum name = "deflection"><para>Call Deflection</para></enum>
-				<enum name = "follow_me"><para>Follow Me</para></enum>
-				<enum name = "out_of_order"><para>Called DTE Out-Of-Order</para></enum>
 				<enum name = "away"><para>Callee is Away</para></enum>
 				<enum name = "cf_dte"><para>Call Forwarding By The Called DTE</para></enum>
+				<enum name = "cfb"><para>Call Forwarding Busy</para></enum>
+				<enum name = "cfnr"><para>Call Forwarding No Reply</para></enum>
 				<enum name = "cfu"><para>Call Forwarding Unconditional</para></enum>
+				<enum name = "deflection"><para>Call Deflection</para></enum>
+				<enum name = "dnd"><para>Do Not Disturb</para></enum>
+				<enum name = "follow_me"><para>Follow Me</para></enum>
+				<enum name = "out_of_order"><para>Called DTE Out-Of-Order</para></enum>
+				<enum name = "send_to_vm"><para>Send the call to voicemail</para></enum>
+				<enum name = "time_of_day"><para>Time of Day</para></enum>
+				<enum name = "unavailable"><para>Callee is Unavailable</para></enum>
+				<enum name = "unknown"><para>Unknown</para></enum>
 			</enumlist>
+			<note><para>You can set a user defined reason string that SIP can
+			send/receive instead.  The user defined reason string my need to be
+			quoted depending upon SIP or the peer's requirements.  These strings
+			are treated as unknown by the non-SIP channel drivers.</para></note>
 			<para>The allowable values for the <replaceable>xxx-name-charset</replaceable>
 			field are the following:</para>
 			<enumlist>

-- 
To view, visit https://gerrit.asterisk.org/2332
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I6e8d39b0711110a4bceafa652e58b30465e28386
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Anonymous Coward #1000019
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>