Ver Fonte

domain: clarifications about string parameters in the docs

Daniel-Constantin Mierla há 8 anos atrás
pai
commit
77f4cea8df
1 ficheiros alterados com 22 adições e 17 exclusões
  1. 22 17
      src/modules/domain/doc/domain_admin.xml

+ 22 - 17
src/modules/domain/doc/domain_admin.xml

@@ -247,17 +247,18 @@ if (is_uri_host_local()) {
 		</example>
 		</example>
 	</section>
 	</section>
 	<section id="domain.f.is_domain_local">
 	<section id="domain.f.is_domain_local">
-		<title><function moreinfo="none">is_domain_local(pseudo_variable)</function></title>
+		<title><function moreinfo="none">is_domain_local(domain)</function></title>
 		<para>
 		<para>
 		This function checks if the domain contained in the
 		This function checks if the domain contained in the
-		pseudo_variable is local.
+		parameter is local. The parameter can be a static string or contain
+		pseduo-variables.
 		</para>
 		</para>
 		<para>
 		<para>
 		This function is a generalized form of the is_from_local()
 		This function is a generalized form of the is_from_local()
 		and is_uri_host_local() functions, being able to completely
 		and is_uri_host_local() functions, being able to completely
 		replace them and also extends them by allowing the domain to
 		replace them and also extends them by allowing the domain to
 		be taken from any of the above mentioned sources.
 		be taken from any of the above mentioned sources.
-                The following equivalences exist:
+        The following equivalences exist:
 		</para>
 		</para>
 		<itemizedlist>
 		<itemizedlist>
 		<listitem><para>
 		<listitem><para>
@@ -277,33 +278,37 @@ if (is_uri_host_local()) {
 ...
 ...
 if (is_domain_local("$rd")) {
 if (is_domain_local("$rd")) {
 	...
 	...
-};
+}
+if (is_domain_local("my.domain.com")) {
+	...
+}
 if (is_domain_local("$fd")) {
 if (is_domain_local("$fd")) {
 	...
 	...
-};
+}
 if (is_domain_local("$avp(some_avp_alias)")) {
 if (is_domain_local("$avp(some_avp_alias)")) {
 	...
 	...
-};
+}
 if (is_domain_local("$avp(i:850)")) {
 if (is_domain_local("$avp(i:850)")) {
 	...
 	...
-};
+}
 if (is_domain_local("$avp(s:some_avp)")) {
 if (is_domain_local("$avp(s:some_avp)")) {
 	...
 	...
-};
+}
 ...
 ...
 		</programlisting>
 		</programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
 	<section id="domain.f.lookup_domain">
 	<section id="domain.f.lookup_domain">
-		<title><function moreinfo="none">lookup_domain(domain[, prefix])</function></title>
-		<para>
-		This function checks if domain given in
-		domain argument (pseudo variable) is local and, if so,
-		adds attributes
-		associated with domain's id (did) to AVPs.  If prefix
-		argument (string) is given, names of attributes are prefixes by
-		it.  In addition to attributes given in domain_attrs
-		table, AVP did containing did of domain is added.
+		<title><function moreinfo="none">lookup_domain(domain [, prefix])</function></title>
+		<para>
+		This function checks if domain given in domain argument is local and,
+		if so, adds attributes associated with domain's id (did) to AVPs.
+		If prefix argument (string) is given, names of attributes are prefixes
+		by it. In addition to attributes given in domain_attrs table, AVP
+		named did containing the did of domain is added.
+		</para>
+		<para>
+		Both parameters can contain pseudo-variables.
 		</para>
 		</para>
 		<para>
 		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,