[SR-Dev] git:master: kex: documentation for km_append_branch()

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 5b04225bf842ce2354ce17cd50ca3c808617bbdb
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5b04225bf842ce2354ce17cd50ca3c808617bbdb

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Tue Apr 28 19:34:29 2009 +0200

kex: documentation for km_append_branch()

---

 modules_k/kex/README            |   22 ++++++++++++++++++++++
 modules_k/kex/doc/kex_admin.xml |   30 ++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 0 deletions(-)

diff --git a/modules_k/kex/README b/modules_k/kex/README
index 104ca84..b5e1986 100644
--- a/modules_k/kex/README
+++ b/modules_k/kex/README
@@ -32,6 +32,7 @@ Daniel-Constantin Mierla
               3.4. setbflag(flag [, branch])
               3.5. isbflagset(flag [, branch])
               3.6. resetsflag(flag [, branch])
+              3.7. km_append_branch([uri])
 
         4. Exported MI Functions
 
@@ -50,6 +51,7 @@ Daniel-Constantin Mierla
    1.4. setbflag usage
    1.5. setbflag usage
    1.6. resetsflag usage
+   1.7. km_append_branch usage
 
 Chapter 1. Admin Guide
 
@@ -69,6 +71,7 @@ Chapter 1. Admin Guide
         3.4. setbflag(flag [, branch])
         3.5. isbflagset(flag [, branch])
         3.6. resetsflag(flag [, branch])
+        3.7. km_append_branch([uri])
 
    4. Exported MI Functions
 
@@ -109,6 +112,7 @@ Chapter 1. Admin Guide
    3.4. setbflag(flag [, branch])
    3.5. isbflagset(flag [, branch])
    3.6. resetsflag(flag [, branch])
+   3.7. km_append_branch([uri])
 
 3.1. setsflag(flag)
 
@@ -221,6 +225,24 @@ if(isbflagset("1"))
 resetbflag("1");
 ...
 
+3.7. km_append_branch([uri])
+
+   Append a new branch to SIP request.
+
+   Meaning of the parameters is as follows:
+     * uri - SIP URI of the new destination. If omitted then the R-URI is
+       used. It can be static string or a string with pseudo-variables
+       that will be evaluated at runtime.
+
+   This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
+
+   Example 1.7. km_append_branch usage
+...
+km_append_branch();
+...
+km_append_branch("sip:alice at sip-router.org");
+...
+
 4. Exported MI Functions
 
    4.1. arg
diff --git a/modules_k/kex/doc/kex_admin.xml b/modules_k/kex/doc/kex_admin.xml
index 9bd4298..7fff6a3 100644
--- a/modules_k/kex/doc/kex_admin.xml
+++ b/modules_k/kex/doc/kex_admin.xml
@@ -247,6 +247,36 @@ resetbflag("1");
 </programlisting>
 		</example>
 		</section>
+		<section>
+		<title><function moreinfo="none">km_append_branch([uri])</function></title>
+		<para>
+			Append a new branch to SIP request.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>uri</emphasis> - SIP URI of the new destination. If
+				omitted then the R-URI is used. It can be static string or
+				a string with pseudo-variables that will be evaluated at
+				runtime.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
+		</para>
+		<example>
+		<title><function>km_append_branch</function> usage</title>
+		<programlisting format="linespecific">
+...
+km_append_branch();
+...
+km_append_branch("sip:alice at sip-router.org");
+...
+</programlisting>
+		</example>
+		</section>
 	</section>
 
 	<section>