瀏覽代碼

corex: minor documentation edits

Olle E. Johansson 12 年之前
父節點
當前提交
287c02de14
共有 2 個文件被更改,包括 20 次插入20 次删除
  1. 13 13
      modules/corex/README
  2. 7 7
      modules/corex/doc/corex_admin.xml

+ 13 - 13
modules/corex/README

@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2012 asipto.com
+   Copyright © 2012 asipto.com
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -71,16 +71,16 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 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
    There are also brand new features, related to core internals, but
    controlled from configuration file or via control interfaces.
    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
 2. Dependencies
 
 
@@ -104,12 +104,12 @@ Chapter 1. Admin Guide
 
 
 3.1. alias_subdomains (string)
 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:
    condition. It can be set many times. Its full format is:
    'proto:domain:port', allowing to set restrictions on protocol and port
    'proto:domain:port', allowing to set restrictions on protocol and port
    as well. Protocol and port are optional.
    as well. Protocol and port are optional.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.1. Set alias_subdomains parameter
    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 ] ])
 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
    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:
    Meaning of the parameters is as follows:
      * uri - SIP address of the branch to be used as R-URI in the outgoing
      * 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
 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:
    Example:
                 sercmd corex.list_aliases
                 sercmd corex.list_aliases

+ 7 - 7
modules/corex/doc/corex_admin.xml

@@ -16,8 +16,8 @@
 	<section>
 	<section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<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
 		The new versions bring support for dynamic parameters (allowing
 		variables inside the parameters).
 		variables inside the parameters).
 	</para>
 	</para>
@@ -26,7 +26,7 @@
 		controlled from configuration file or via control interfaces.
 		controlled from configuration file or via control interfaces.
 	</para>
 	</para>
 	<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.
 		follow the requirements of the core contributions.
 	</para>
 	</para>
 	</section>
 	</section>
@@ -67,7 +67,7 @@
 	<section>
 	<section>
 	    <title><varname>alias_subdomains</varname> (string)</title>
 	    <title><varname>alias_subdomains</varname> (string)</title>
 	    <para>
 	    <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:
 		condition. It can be set many times. Its full format is:
 		'proto:domain:port', allowing to set restrictions on protocol
 		'proto:domain:port', allowing to set restrictions on protocol
 		and port as well. Protocol and port are optional.
 		and port as well. Protocol and port are optional.
@@ -97,11 +97,11 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 	    </title>
 	    </title>
 	    <para>
 	    <para>
 			Append a new branch to the destination set, useful to build the
 			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>
 		<para>
 		<para>
 			Both parameters are optional, If no uri parameter is provided,
 			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.
 			new branch.
 		</para>
 		</para>
 		<para>Meaning of the parameters is as follows:</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>
 		<function moreinfo="none">corex.list_aliases</function>
 		</title>
 		</title>
 		<para>
 		<para>
-			Print the list of hostname aliases used to match myself
+			Print the list of hostname aliases used to match the myself
 			condition.
 			condition.
 		</para>
 		</para>
 		<para>
 		<para>