[sr-dev] git:master:374f0f05: textops: docs - some enhancements to basic header operations functions

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 374f0f05bdf27ddaf5d8652560738fbfb886c43c
URL: https://github.com/kamailio/kamailio/commit/374f0f05bdf27ddaf5d8652560738fbfb886c43c

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-10-26T10:53:24+01:00

textops: docs - some enhancements to basic header operations functions

---

Modified: src/modules/textops/doc/textops_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/374f0f05bdf27ddaf5d8652560738fbfb886c43c.diff
Patch: https://github.com/kamailio/kamailio/commit/374f0f05bdf27ddaf5d8652560738fbfb886c43c.patch

---

diff --git a/src/modules/textops/doc/textops_admin.xml b/src/modules/textops/doc/textops_admin.xml
index a8685510a0..44540841d4 100644
--- a/src/modules/textops/doc/textops_admin.xml
+++ b/src/modules/textops/doc/textops_admin.xml
@@ -872,13 +872,15 @@ if (has_body("multipart/mixed")) {
 		<function moreinfo="none">append_to_reply(txt)</function>
 		</title>
 		<para>
-		Append txt as header to the reply.
+		Append txt as header to the reply that is going to be generated by
+		&kamailio; (e.g., via sl_send_reply(...)).
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<listitem>
 			<para><emphasis>txt</emphasis> - String which may contains
-			pseudo-variables.
+			pseudo-variables. Note that the value has to be ended with "\r\n"
+			(end of header characters sequence).
 			</para>
 		</listitem>
 		</itemizedlist>
@@ -902,15 +904,16 @@ append_to_reply("Foo: $rm at $Ts\r\n");
 		<function moreinfo="none">append_hf(txt[, hdr])</function>
 		</title>
 		<para>
-		Appends 'txt' as header after first header field or after
-		last 'hdr' header field.
+		Appends 'txt' as header at the end of the all headers, or after
+		last header named 'hdr' if the second parameter is provided.
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<listitem>
 			<para><emphasis>txt</emphasis> - Header field to be appended. The
 			value can contain pseudo-variables which will be replaced at run
-			time.
+			time. Note that the value has to be ended with "\r\n" (end of header
+			characters sequence).
 			</para>
 		</listitem>
 		<listitem>
@@ -939,15 +942,16 @@ append_hf("From-username: $fU\r\n", "Call-ID");
 		<function moreinfo="none">insert_hf(txt[, hdr])</function>
 		</title>
 		<para>
-		Inserts 'txt' as header before the first header field or before
-		first 'hdr' header field if 'hdr' is given.
+		Inserts 'txt' as header before the first header field, or before
+		first header named 'hdr'if the second parameter is provided.
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<listitem>
 			<para><emphasis>txt</emphasis> - Header field to be inserted. The
 			value can contain pseudo-variables which will be replaced at run
-			time.
+			time. Note that the value has to be ended with "\r\n" (end of header
+			characters sequence).
 			</para>
 		</listitem>
 		<listitem>