kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-04 11:58:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Standardize examples

Browse Source 
Most examples in the XML documentation use the
example tag to demonstrate examples, which gets
parsed specially in the Wiki to make it easier
to follow for users.

This fixes a few modules to use the example
tag instead of vanilla para tags to bring them
in line with the standard syntax.

ASTERISK-29777 #close

Change-Id: I9acb6cc5faf1d220e73c6dd28592371d768d279b
This commit is contained in:
Naveen Albert
2021-11-25 18:41:18 +00:00
committed by Friendly Automation
parent 2478bfcff9
commit 24a04054ad
8 changed files with 78 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
channels/chan_sip.c
View File

@@ -339,17 +339,19 @@
added with SIPAddHeader(). If no parameter is supplied, all previously added
headers will be removed. If a parameter is supplied, only the matching headers
will be removed.</para>
<para>For example you have added these 2 headers:</para>
<para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
<para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
<para></para>
<para>// remove all headers</para>
<para>SIPRemoveHeader();</para>
<para>// remove all P- headers</para>
<para>SIPRemoveHeader(P-);</para>
<para>// remove only the PAI header (note the : at the end)</para>
<para>SIPRemoveHeader(P-Asserted-Identity:);</para>
<para></para>
<example title="Add 2 headers">
same => n,SIPAddHeader(P-Asserted-Identity: sip:foo@bar)
same => n,SIPAddHeader(P-Preferred-Identity: sip:bar@foo)
</example>
<example title="Remove all headers">
same => n,SIPRemoveHeader()
</example>
<example title="Remove all P- headers">
same => n,SIPRemoveHeader(P-)
</example>
<example title="Remove only the PAI header (note the : at the end)">
same => n,SIPRemoveHeader(P-Asserted-Identity:)
</example>
<para>Always returns <literal>0</literal>.</para>
</description>
</application>