[Asterisk-code-review] res pjsip: Add clarifying documentation to PJSIP HEADER help... (asterisk[13])

[Rusty Newton]

Rusty Newton has uploaded a new change for review.

  https://gerrit.asterisk.org/2916

Change subject: res_pjsip: Add clarifying documentation to PJSIP_HEADER help text
......................................................................

res_pjsip: Add clarifying documentation to PJSIP_HEADER help text

Added notes about when you can read or write headers. Specifically
about being able to read on the inbound channel and write on an
outbound channel.

ASTERISK-26063 #close
Reported by: Private Name
Tested by: Rusty Newton

Change-Id: Ibeb64af17d1f6451028b3c29855a3f151a01d8c5
---
M res/res_pjsip_header_funcs.c
1 file changed, 7 insertions(+), 2 deletions(-)


  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/16/2916/1

diff --git a/res/res_pjsip_header_funcs.c b/res/res_pjsip_header_funcs.c
index 4ab3fb1..47b72f9 100644
--- a/res/res_pjsip_header_funcs.c
+++ b/res/res_pjsip_header_funcs.c
@@ -39,7 +39,8 @@
 /*** DOCUMENTATION
 	<function name="PJSIP_HEADER" language="en_US">
 		<synopsis>
-			Gets, adds, updates or removes the specified SIP header from a PJSIP session.
+			Gets headers from an inbound PJSIP channel. Adds, updates or removes the
+			specified SIP header from a outbound PJSIP channel.
 		</synopsis>
 		<syntax>
 			<parameter name="action" required="true">
@@ -75,6 +76,10 @@
 
 		</syntax>
 		<description>
+			<para>PJSIP_HEADER allows you to read specific SIP headers from the inbound
+			PJSIP channel as well as write(add, update, remove) headers on the outbound
+			channel. One exception is that you can read headers that you have already
+			added on the outbound channel.</para>
 			<para>Examples:</para>
 			<para>;</para>
 			<para>; Set 'somevar' to the value of the 'From' header.</para>
@@ -120,7 +125,7 @@
 
 			<note><para>If you call PJSIP_HEADER in a normal dialplan context you'll be
 			operating on the <emphasis>caller's (incoming)</emphasis> channel which
-			may not be what you want.  To operate on the <emphasis>callee's (outgoing)</emphasis>
+			may not be what you want. To operate on the <emphasis>callee's (outgoing)</emphasis>
 			channel call PJSIP_HEADER in a pre-dial handler. </para>
 			<para>Example:</para>
 			<para>;</para>

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ibeb64af17d1f6451028b3c29855a3f151a01d8c5
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-Owner: Rusty Newton <rnewton at digium.com>