[sr-dev] git:master:63f596e4: corex: docs for via_add_xavp_params() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 63f596e412c4800c191c17498edd06433ca9a949
URL: https://github.com/kamailio/kamailio/commit/63f596e412c4800c191c17498edd06433ca9a949

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-04-19T18:24:36+02:00

corex: docs for via_add_xavp_params() function

---

Modified: src/modules/corex/doc/corex_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/63f596e412c4800c191c17498edd06433ca9a949.diff
Patch: https://github.com/kamailio/kamailio/commit/63f596e412c4800c191c17498edd06433ca9a949.patch

---

diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
index a8076b36c5..bada400b9f 100644
--- a/src/modules/corex/doc/corex_admin.xml
+++ b/src/modules/corex/doc/corex_admin.xml
@@ -603,7 +603,34 @@ via_add_srv("1");
 </programlisting>
 		</example>
 		</section>
+		<section id="corex.f.via_add_xavp_params">
+		<title><function moreinfo="none">via_add_xavp_params(flags)</function></title>
+		<para>
+			Control if fields of the xavp with the name specified by
+			xavp_via_params global parameter are added or not to local Via.
 
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>flags</emphasis>: 1 - add xavp parameters; 0 - do not
+				add xavp parameters.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>via_add_xavp_params</function> usage</title>
+		<programlisting format="linespecific">
+...
+via_add_xavp_params("1");
+...
+</programlisting>
+		</example>
+		</section>
 	</section>
 
 	<section>