[svn-commits] oej: trunk r335349 - /trunk/channels/chan_sip.c

[SVN commits to the Digium repositories]

Author: oej
Date: Mon Sep 12 09:22:56 2011
New Revision: 335349

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=335349
Log:
Small documentation updates

Modified:
    trunk/channels/chan_sip.c

Modified: trunk/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_sip.c?view=diff&rev=335349&r1=335348&r2=335349
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Mon Sep 12 09:22:56 2011
@@ -340,7 +340,7 @@
 	</application>
 	<function name="SIP_HEADER" language="en_US">
 		<synopsis>
-			Gets the specified SIP header.
+			Gets the specified SIP header from an incoming INVITE message.
 		</synopsis>
 		<syntax>
 			<parameter name="name" required="true" />
@@ -352,6 +352,8 @@
 			<para>Since there are several headers (such as Via) which can occur multiple
 			times, SIP_HEADER takes an optional second argument to specify which header with
 			that name to retrieve. Headers start at offset <literal>1</literal>.</para>
+			<para>Please observe that contents of the SDP (an attachment to the 
+			SIP request) can't be accessed with this function.</para>
 		</description>
 	</function>
 	<function name="SIPPEER" language="en_US">
@@ -363,7 +365,7 @@
 			<parameter name="item">
 				<enumlist>
 					<enum name="ip">
-						<para>(default) The ip address.</para>
+						<para>(default) The IP address.</para>
 					</enum>
 					<enum name="port">
 						<para>The port number.</para>