[sr-dev] git:master: corex: minor documentation edits

Module: sip-router Branch: master Commit: 287c02de1491019fbf085742b82fc7040ea72886 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=287c02d… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Mon Dec 3 08:01:06 2012 +0100 corex: minor documentation edits --- modules/corex/README | 26 +++++++++++++------------- modules/corex/doc/corex_admin.xml | 14 +++++++------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/modules/corex/README b/modules/corex/README index 402089a..ecceeaf 100644 --- a/modules/corex/README +++ b/modules/corex/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; - Copyright © 2012 asipto.com + Copyright � 2012 asipto.com __________________________________________________________________ Table of Contents @@ -71,16 +71,16 @@ Chapter 1. Admin Guide 1. Overview - This module provides reimplementation of very old functions that were - in core and supported only static string or integer parameters. The new - versions bring support for dynamic parameters (allowing variables - inside the parameters). + This module provides reimplementation of a few very old functions that + used to be in the core and supported only static string or integer + parameters. The new versions bring support for dynamic parameters + (allowing variables inside the parameters). There are also brand new features, related to core internals, but controlled from configuration file or via control interfaces. - Contributions to this module must be done under BSD license, to follow - the requirements of the core contributions. + Contributions to this module must be done under the BSD license, to + follow the requirements of the core contributions. 2. Dependencies @@ -104,12 +104,12 @@ Chapter 1. Admin Guide 3.1. alias_subdomains (string) - Register a domain and all its sub-domains to match the myself + Register a domain and all its sub-domains to match the "myself" condition. It can be set many times. Its full format is: 'proto:domain:port', allowing to set restrictions on protocol and port as well. Protocol and port are optional. - Default value is “NULL”. + Default value is "NULL". Example 1.1. Set alias_subdomains parameter ... @@ -125,11 +125,11 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060") 4.1. append_branch([ uri, [ q ] ]) - Append a new branch to the destination set, useful to build the - addresses for parallel forking or redirect replies. + Append a new branch to the destination set, useful to build the set of + destination addresses for parallel forking or redirect replies. Both parameters are optional, If no uri parameter is provided, then the - address from request URI (r-uri) is taken to build the new branch. + address from request URI (r-uri) is used to build the new branch. Meaning of the parameters is as follows: * uri - SIP address of the branch to be used as R-URI in the outgoing @@ -186,7 +186,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060") 5.2. corex.list_aliases - Print the list of hostname aliases used to match myself condition. + Print the list of hostname aliases used to match the myself condition. Example: sercmd corex.list_aliases diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml index 5dd72e7..3291cfd 100644 --- a/modules/corex/doc/corex_admin.xml +++ b/modules/corex/doc/corex_admin.xml @@ -16,8 +16,8 @@ <section> <title>Overview</title> <para> - This module provides reimplementation of very old functions that - were in core and supported only static string or integer parameters. + This module provides reimplementation of a few very old functions that + used to be in the core and supported only static string or integer parameters. The new versions bring support for dynamic parameters (allowing variables inside the parameters). </para> @@ -26,7 +26,7 @@ controlled from configuration file or via control interfaces. </para> <para> - Contributions to this module must be done under BSD license, to + Contributions to this module must be done under the BSD license, to follow the requirements of the core contributions. </para> </section> @@ -67,7 +67,7 @@ <section> <title><varname>alias_subdomains</varname> (string)</title> <para> - Register a domain and all its sub-domains to match the myself + Register a domain and all its sub-domains to match the <quote>myself</quote> condition. It can be set many times. Its full format is: 'proto:domain:port', allowing to set restrictions on protocol and port as well. Protocol and port are optional. @@ -97,11 +97,11 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060") </title> <para> Append a new branch to the destination set, useful to build the - addresses for parallel forking or redirect replies. + set of destination addresses for parallel forking or redirect replies. </para> <para> Both parameters are optional, If no uri parameter is provided, - then the address from request URI (r-uri) is taken to build the + then the address from request URI (r-uri) is used to build the new branch. </para> <para>Meaning of the parameters is as follows:</para> @@ -201,7 +201,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060") <function moreinfo="none">corex.list_aliases</function> </title> <para> - Print the list of hostname aliases used to match myself + Print the list of hostname aliases used to match the myself condition. </para> <para>