[sr-dev] git:master:77f4cea8: domain: clarifications about string parameters in the docs

Module: kamailio Branch: master Commit: 77f4cea8df15920f33f0f017c7303d2306aeee83 URL: https://github.com/kamailio/kamailio/commit/77f4cea8df15920f33f0f017c7303d2… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2017-04-25T18:12:36+02:00 domain: clarifications about string parameters in the docs --- Modified: src/modules/domain/doc/domain_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/77f4cea8df15920f33f0f017c7303d2… Patch: https://github.com/kamailio/kamailio/commit/77f4cea8df15920f33f0f017c7303d2… --- diff --git a/src/modules/domain/doc/domain_admin.xml b/src/modules/domain/doc/domain_admin.xml index c0c99bd..561fb92 100644 --- a/src/modules/domain/doc/domain_admin.xml +++ b/src/modules/domain/doc/domain_admin.xml @@ -247,17 +247,18 @@ if (is_uri_host_local()) { </example> </section> <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> 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> This function is a generalized form of the is_from_local() and is_uri_host_local() functions, being able to completely replace them and also extends them by allowing the domain to be taken from any of the above mentioned sources. - The following equivalences exist: + The following equivalences exist: </para> <itemizedlist> <listitem><para> @@ -277,33 +278,37 @@ if (is_uri_host_local()) { ... if (is_domain_local("$rd")) { ... -}; +} +if (is_domain_local("my.domain.com")) { + ... +} if (is_domain_local("$fd")) { ... -}; +} if (is_domain_local("$avp(some_avp_alias)")) { ... -}; +} if (is_domain_local("$avp(i:850)")) { ... -}; +} if (is_domain_local("$avp(s:some_avp)")) { ... -}; +} ... </programlisting> </example> </section> <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> This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,