[sr-dev] git:kamailio_3.0: tm: updated doc for t_drop_replies()

[Daniel-Constantin Mierla]

Module: sip-router
Branch: kamailio_3.0
Commit: cb1866ee7b23688d12b222d503b1709f16f75a12
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=cb1866ee7b23688d12b222d503b1709f16f75a12

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Wed Dec 23 17:34:09 2009 +0100

tm: updated doc for t_drop_replies()

---

 modules/tm/README            |   15 ++++++++++-----
 modules/tm/doc/functions.xml |   13 ++++++++++---
 2 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/modules/tm/README b/modules/tm/README
index 64ede44..a257952 100644
--- a/modules/tm/README
+++ b/modules/tm/README
@@ -96,7 +96,7 @@ Juha Heinanen
         1.5.26. t_is_expired()
         1.5.27. t_relay_cancel()
         1.5.28. t_lookup_cancel(), t_lookup_cancel(1)
-        1.5.29. t_drop_replies()
+        1.5.29. t_drop_replies([mode])
         1.5.30. t_save_lumps()
         1.5.31. t_load_contacts()
         1.5.32. t_next_contacts()
@@ -1718,12 +1718,17 @@ if (method == CANCEL) {
         # do the same as for INVITEs
 }
 
-1.5.29.  t_drop_replies()
+1.5.29.  t_drop_replies([mode])
 
    Drops all the previously received replies in failure_route block to
-   make sure that none of them is picked up again. Works only if a new
-   branch is added to the transaction, or it is explicitly replied in the
-   script!
+   make sure that none of them is picked up again.
+
+   The parameter 'mode' controls which replies are dropped: 'a' or missing
+   - all replies are dropped; 'l' - replies received for last set of
+   branches are dropped; 'n' - no reply is dropped.
+
+   Dropping replies works only if a new branch is added to the
+   transaction, or it is explicitly replied in the script!
 
    Example 66. t_drop_replies() usage
 ...
diff --git a/modules/tm/doc/functions.xml b/modules/tm/doc/functions.xml
index c8f09d7..5aee3bb 100644
--- a/modules/tm/doc/functions.xml
+++ b/modules/tm/doc/functions.xml
@@ -946,13 +946,20 @@ if (method == CANCEL) {
 
     <section id="t_drop_replies">
 	<title>
-	    <function>t_drop_replies()</function>
+	    <function>t_drop_replies([mode])</function>
 	</title>
 	<para>
 		Drops all the previously received replies in failure_route
 		block to make sure that none of them is picked up again.
-		Works only if a new branch is added to the transaction,
-		or it is explicitly replied in the script!
+	</para>
+	<para>
+		The parameter 'mode' controls which replies are dropped: 'a'
+		or missing - all replies are dropped; 'l' - replies received for
+		last set of branches are dropped; 'n' - no reply is dropped.
+	</para>
+	<para>
+		Dropping replies works only if a new branch is added to the
+		transaction, or it is explicitly replied in the script!
 	</para>
 	<example>
 	    <title><function>t_drop_replies()</function> usage</title>