[sr-dev] git:master:d319c449: dialog: proper description of is_in_profile() to match the code

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-11-22T19:15:16+01:00

dialog: proper description of is_in_profile() to match the code

- reported by GH #1320

---

Modified: src/modules/dialog/doc/dialog_admin.xml

---

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

---

diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml
index e0041f75ed..4e7a654b2f 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -1608,11 +1608,12 @@ unset_dlg_profile("caller","$fu");
 		</title>
 		<para>
 		Checks if the current dialog belongs to a profile. If the profile
-		supports values, the check can be reinforced to take into account a
-		specific value, if the dialog was inserted into the profile for a
-		specific value. If no value is passed, only the membership of
-		the dialog in the profile per se is checked. Note that if the profile does
-		not support values, the value parameter will be silently discarded.
+		is defined with values, then the check is also matching with the
+		specific value provided as parameter.
+		</para>
+		<para>
+		Note that if the profile is not defined with support for values, the
+		value parameter will be silently discarded.
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
@@ -1623,13 +1624,13 @@ unset_dlg_profile("caller","$fu");
 		</listitem>
 		<listitem>
 			<para><emphasis>value</emphasis> (optional) - string value to
-			further restrict the check. Pseudo-variables are supported.
+			be matched during the check. Pseudo-variables are supported.
 			</para>
 		</listitem>
 		</itemizedlist>
 		<para>
 		This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
-			REPLY_ROUTE and FAILURE_ROUTE.
+		REPLY_ROUTE and FAILURE_ROUTE.
 		</para>
 		<example>
 		<title><function>is_in_profile</function> usage</title>