- Doxygen updates

- Replace Kamailio with "&kamailio;" in xml files
- Update README's because of this

modules/carrierroute/README

@@ -499,7 +499,7 @@ cr_user_rewrite_uri(uri, domain)
 cr_tree_rewrite_uri(tree, domain)
 -> cr_route(tree, domain, "$rU", "$rU", "call_id")
 
-4.1.  cr_user_carrier(user, domain, dstavp)
+4.1. cr_user_carrier(user, domain, dstavp)
 
    This function loads the carrier and stores it in an AVP. It cannot be
    used in the config file mode, as it needs a mapping of the given user
@@ -516,7 +516,7 @@ cr_tree_rewrite_uri(tree, domain)
        string any pseudo-variable could be used as input.
      * dstavp - Name of the AVP where to store the carrier id.
 
-4.2.  cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source,
+4.2. cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source,
 descavp)
 
    This function searches for the longest match for the user given in
@@ -558,7 +558,7 @@ descavp)
      * decsavp - Name of the AVP where to store the description. This
        parameter is optional.
 
-4.3.  cr_prime_route(carrier, domain, prefix_matching, rewrite_user,
+4.3. cr_prime_route(carrier, domain, prefix_matching, rewrite_user,
 hash_source, descavp)
 
    This function searches for the longest match for the user given in
@@ -604,7 +604,7 @@ hash_source, descavp)
      * descavp - Name of the AVP where to store the description. This
        parameter is optional.
 
-4.4.  cr_nofallback_route(carrier, domain, prefix_matching, rewrite_user,
+4.4. cr_nofallback_route(carrier, domain, prefix_matching, rewrite_user,
 hash_source, descavp)
 
    This function searches for the longest match for the user given in
@@ -645,7 +645,7 @@ hash_source, descavp)
      * descavp - Name of the AVP where to store the description. This
        parameter is optional.
 
-4.5.  cr_next_domain(carrier, domain, prefix_matching, host, reply_code,
+4.5. cr_next_domain(carrier, domain, prefix_matching, host, reply_code,
 dstavp)
 
    This function searches for the longest match for the user given in

modules/carrierroute/doc/carrierroute_admin.xml

@@ -15,7 +15,7 @@
 	<para>A module which provides routing, balancing and blacklisting capabilities.</para>
 	<para>
 		The module provides routing, balancing and blacklisting capabilities.
-		It reads routing entries from a database source or from a config file at Kamailio
+		It reads routing entries from a database source or from a config file at &kamailio;
 		startup. It can uses one routing tree (for one carrier), or if needed for every user
 		a different routing tree (unique for each carrier) for number prefix based routing.
 		It supports several route tree domains,	e.g. for failback routes or different routing

modules/dialplan/doc/dialplan_admin.xml

@@ -509,7 +509,7 @@ xlog("translated to var $var(y) \n");
     <section>
 	    <title>Installation</title>
 	    <para>
-        The modules requires one table in Kamailio database: dialplan. The SQL 
+        The modules requires one table in &kamailio; database: dialplan. The SQL 
         syntax to create them can be found in dialplan-create.sql     
         script in the database directories in the kamailio/scripts folder.
         You can also find the complete database documentation on the

modules/pdb/doc/pdb_admin.xml

@@ -20,11 +20,11 @@
 	the reply to the configuration script.
 	</para>
 	<para>
-	The pdb module allows Kamailio to send queries to a list of servers
-  and store the answer in an AVP. The idea is to ask all servers in
-  parallel and use the first answer, that comes back. A timeout for the
+	The pdb module allows &kamailio; to send queries to a list of servers
+  	and store the answer in an AVP. The idea is to ask all servers in
+  	parallel and use the first answer, that comes back. A timeout for the
 	query can be defined in milliseconds. The queying can be activated and
-  deactivated using FIFO commands.
+  	deactivated using FIFO commands.
 	</para>
 	</section>
 

modules/peering/README

@@ -12,30 +12,30 @@ Juha Heinanen
 
    Copyright © 2008 Juha Heinanen
    Revision History
-   Revision $Revision: 4261 $ $Date: 2008-05-30 01:03:56 +0200
-                              (Fri, 30 Apr 2008) $
-     __________________________________________________________
+   Revision $Revision: 4261 $ $Date: 2008-05-30 01:03:56 +0200 (Fri, 30
+   Apr 2008) $
+     __________________________________________________________________
 
    Table of Contents
 
    1. Admin Guide
 
-        1.1. Overview
-        1.2. Dependencies
+        1. Overview
+        2. Dependencies
 
-              1.2.1. Kamailio Modules
-              1.2.2. External Libraries or Applications
+              2.1. Kamailio Modules
+              2.2. External Libraries or Applications
 
-        1.3. Exported Parameters
+        3. Exported Parameters
 
-              1.3.1. radius_config (string)
-              1.3.2. verify_destination_service_type (integer)
-              1.3.3. verify_source_service_type (integer)
+              3.1. radius_config (string)
+              3.2. verify_destination_service_type (integer)
+              3.3. verify_source_service_type (integer)
 
-        1.4. Exported Functions
+        4. Exported Functions
 
-              1.4.1. verify_destination()
-              1.4.2. verify_source()
+              4.1. verify_destination()
+              4.2. verify_source()
 
    List of Examples
 
@@ -47,116 +47,140 @@ Juha Heinanen
 
 Chapter 1. Admin Guide
 
-1.1. Overview
-
-   Peering module allows SIP providers (operators or
-   organizations) to verify from a broker if source or destination
-   of a SIP request is a trusted peer.
-
-   In order to participate in the trust community provided by a
-   broker, each SIP provider registers with the broker the domains
-   (host parts of SIP URIs) that they serve. When a SIP proxy of a
-   provider needs to send a SIP request to a non-local domain, it
-   can find out from the broker using verify_destination()
-   function if the non-local domain is served by a trusted peer.
-   If so, the provider receives from the broker a hash of the SIP
-   request and a timestamp that it includes in the request to the
-   non-local domain. When a SIP proxy of the non-local domain
-   receives the SIP request, it, in turn, can verify from the
-   broker using verify_source() function if the request came from
-   a trusted peer.
+   Table of Contents
+
+   1. Overview
+   2. Dependencies
+
+        2.1. Kamailio Modules
+        2.2. External Libraries or Applications
+
+   3. Exported Parameters
+
+        3.1. radius_config (string)
+        3.2. verify_destination_service_type (integer)
+        3.3. verify_source_service_type (integer)
+
+   4. Exported Functions
+
+        4.1. verify_destination()
+        4.2. verify_source()
+
+1. Overview
+
+   The peering module allows SIP providers (operators or organizations) to
+   verify from a broker if source or destination of a SIP request is a
+   trusted peer.
+
+   In order to participate in the trust community provided by a broker,
+   each SIP provider registers the domains (host parts of SIP URIs) that
+   they serve with the broker. When a SIP proxy of a provider needs to
+   send a SIP request to a non-local domain, it can find out from the
+   broker using verify_destination() function if the non-local domain is
+   served by a trusted peer. If so, the provider receives from the broker
+   a hash of the SIP request and a timestamp that it includes in the
+   request to the non-local domain. When a SIP proxy of the non-local
+   domain receives the SIP request, it, in turn, can verify from the
+   broker using verify_source() function if the request came from a
+   trusted peer.
 
    Verification functions communicate with the broker using Radius
-   protocol. Sample FreeRADIUS configuration files for broker's
-   Radius server are available from http://www.wirlab.net/tsi/.
+   protocol. Sample FreeRADIUS configuration files for broker's Radius
+   server are available from http://www.wirlab.net/tsi/.
 
    Comments and suggestions for improvements are welcome.
 
-1.2. Dependencies
+2. Dependencies
 
-1.2.1. Kamailio Modules
+   2.1. Kamailio Modules
+   2.2. External Libraries or Applications
 
-   The module depends on the following modules (in the other words
-   the listed modules must be loaded before this module):
+2.1. Kamailio Modules
+
+   The module depends on the following modules (in the other words the
+   listed modules must be loaded before this module):
      * none
 
-1.2.2. External Libraries or Applications
+2.2. External Libraries or Applications
+
+   The following libraries or applications must be installed before
+   compilling Kamailio with this module loaded:
+     * radiusclient-ng 0.5.0 or higher -- library and development files.
+       See http://developer.berlios.de/projects/radiusclient-ng/.
 
-   The following libraries or applications must be installed
-   before compilling Kamailio with this module loaded:
-     * radiusclient-ng 0.5.0 or higher -- library and development
-       files. See
-       http://developer.berlios.de/projects/radiusclient-ng/.
+3. Exported Parameters
 
-1.3. Exported Parameters
+   3.1. radius_config (string)
+   3.2. verify_destination_service_type (integer)
+   3.3. verify_source_service_type (integer)
 
-1.3.1. radius_config (string)
+3.1. radius_config (string)
 
-   This is the location of the configuration file of radius client
+   This is the location of the configuration file of Radius client
    libraries.
 
-   Default value is
-   "/usr/local/etc/radiusclient-ng/radiusclient.conf".
+   Default value is "/usr/local/etc/radiusclient-ng/radiusclient.conf".
 
    Example 1.1. radius_config parameter usage
 modparam("peering", "radius_config", "/etc/broker/radiusclient.conf")
 
-1.3.2. verify_destination_service_type (integer)
+3.2. verify_destination_service_type (integer)
 
-   This is the value of the Service-Type Radius attribute to be
-   used, when sender of SIP Request verifies request's destination
-   using verify_destination() function.
+   This is the value of the Service-Type Radius attribute to be used, when
+   sender of SIP Request verifies the request's destination using
+   verify_destination() function.
 
-   Default value is dictionary value of "Sip-Verify-Destination"
+   Default value is the dictionary value of "Sip-Verify-Destination"
    Service-Type.
 
    Example 1.2. verify_destination_service_type parameter usage
 modparam("peering", "verify_destination_service_type", 21)
 
-1.3.3. verify_source_service_type (integer)
+3.3. verify_source_service_type (integer)
 
-   This is the value of the Service-Type Radius attribute to be
-   used, when receiver of SIP Request verifies request's source
-   using verify_source() function.
+   This is the value of the Service-Type Radius attribute to be used, when
+   receiver of SIP Request verifies the request's source using
+   verify_source() function.
 
-   Default value is dictionary value of "Sip-Verify-Source"
+   Default value is the dictionary value of "Sip-Verify-Source"
    Service-Type.
 
    Example 1.3. verify_source_service_type parameter usage
 modparam("peering", "verify_source_service_type", 22)
 
-1.4. Exported Functions
+4. Exported Functions
+
+   4.1. verify_destination()
+   4.2. verify_source()
 
-1.4.1. verify_destination()
+4.1. verify_destination()
 
-   Function verify_destination() queries from broker's Radius
-   server if domain (host part) of Request URI is served by a
-   trusted peer. Radius request contains the following
-   attributes/values:
+   Function verify_destination() queries from broker's Radius server if
+   domain (host part) of Request URI is served by a trusted peer. Radius
+   request contains the following attributes/values:
      * User-Name - Request-URI host
      * SIP-URI-User - Request-URI user
      * SIP-From-Tag - From tag
      * SIP-Call-Id - Call id
      * Service-Type - verify_destination_service_type
 
-   Function returns value 1 if domain of Request URI is served by
-   a trusted peer and -1 otherwise. In case of positive result,
-   Radius server returns a set of SIP-AVP reply attributes. Value
-   of each SIP-AVP is of form:
+   Function returns value 1 if domain of Request URI is served by a
+   trusted peer and -1 otherwise. In case of positive result, the Radius
+   server returns a set of SIP-AVP reply attributes. The value of each
+   SIP-AVP is of form:
 
    [#]name(:|#)value
 
-   Value of each SIP-AVP reply attribute is mapped to an Kamailio
-   AVP. Prefix # in front of name or value indicates a string name
-   or string value, respectively.
+   Value of each SIP-AVP reply attribute is mapped to an Kamailio AVP.
+   Prefix # in front of name or value indicates a string name or string
+   value, respectively.
 
-   One of the SIP-AVP reply attributes contains a string that the
-   source peer must include "as is" in a P-Request-Hash header
-   when it sends the SIP request to the destination peer. The
-   string value may, for example, be of form hash@timestamp, where
-   hash contains a hash calculated by the broker based on the
-   attributes of the query and some local information and
-   timestamp is the time when the calculation was done.
+   One of the SIP-AVP reply attributes contains a string that the source
+   peer must include "as is" in a P-Request-Hash: header when it sends the
+   SIP request to the destination peer. The string value may, for example,
+   be of form hash@timestamp, where hash contains a hash calculated by the
+   broker based on the attributes of the query and some local information
+   and timestamp is the time when the calculation was done.
 
    AVP names used in reply attributes are assigned by the broker.
 
@@ -169,10 +193,10 @@ if (verify_destination()) {
 }
 ...
 
-1.4.2. verify_source()
+4.2. verify_source()
 
-   Function verify_source() queries from broker's Radius server if
-   SIP request was received from a trusted peer. Radius request
+   Function verify_source() queries the broker's Radius server whether the
+   SIP request was received from a trusted peer. The Radius request
    contains the following attributes/values:
      * User-Name - Request-URI host
      * SIP-URI-User - Request-URI user
@@ -181,16 +205,16 @@ if (verify_destination()) {
      * SIP-Request-Hash - body of P-Request-Hash header
      * Service-Type - verify_source_service_type
 
-   Function returns value 1 if SIP request was received from a
-   trusted peer and -1 otherwise. In case of positive result,
-   Radius server may return a set of SIP-AVP reply attributes.
-   Value of each SIP-AVP is of form:
+   Function returns value 1 if SIP request was received from a trusted
+   peer and -1 otherwise. In case of positive result, Radius server may
+   return a set of SIP-AVP reply attributes. Value of each SIP-AVP is of
+   form:
 
    [#]name(:|#)value
 
-   Value of each SIP-AVP reply attribute is mapped to an Kamailio
-   AVP. Prefix # in front of name or value indicates a string name
-   or string value, respectively.
+   Value of each SIP-AVP reply attribute is mapped to an Kamailio AVP.
+   Prefix # in front of name or value indicates a string name or string
+   value, respectively.
 
    AVP names used in reply attributes are assigned by the broker.
 

modules/peering/doc/peering_admin.xml

@@ -16,21 +16,19 @@
 
 	<section>
 	<title>Overview</title>
-	<para> Peering module allows SIP
-	providers (operators or organizations) to verify from a broker
-	if source or destination of a SIP request is a trusted peer.
+	<para>The peering module allows SIP providers (operators or organizations) 
+	to verify from a broker if source or destination of a SIP request is a trusted peer.
         </para>
         <para>
 	In order to participate in the trust community provided by a
-	broker, each SIP provider registers with the broker the domains
-	(host parts of SIP URIs) that they serve.  When a SIP proxy of a
+	broker, each SIP provider registers the domains (host parts of SIP URIs) 
+	that they serve with the broker.  When a SIP proxy of a
 	provider needs to send a SIP request to a non-local domain, it
 	can find out from the broker using verify_destination() function
 	if the non-local domain is served by a trusted peer.  If so, the
 	provider receives from the broker a hash of the SIP request and
 	a timestamp that it includes in the request to the non-local
-	domain.  When a SIP
-	proxy of the non-local domain receives the SIP request, it, in
+	domain.  When a SIP proxy of the non-local domain receives the SIP request, it, in
 	turn, can verify from the broker using verify_source() function
 	if the request came from a trusted peer.
         </para>
@@ -86,7 +84,7 @@
 	<section>
 		<title><varname>radius_config</varname> (string)</title>
 		<para>
-		This is the location of the configuration file of radius client 
+		This is the location of the configuration file of Radius client 
 		libraries.
 		</para>
 		<para>
@@ -104,11 +102,11 @@ modparam("peering", "radius_config", "/etc/broker/radiusclient.conf")
 		<title><varname>verify_destination_service_type</varname> (integer)</title>
 		<para>
 		This is the value of the Service-Type Radius attribute to be
-		used, when sender of SIP Request verifies request's
-	destination using verify_destination() function.
+		used, when sender of SIP Request verifies the request's
+		destination using verify_destination() function.
 		</para>
 		<para>
-		Default value is dictionary value of <quote>Sip-Verify-Destination</quote>
+		Default value is the dictionary value of <quote>Sip-Verify-Destination</quote>
 		Service-Type.
 		</para>
 		<example>
@@ -122,11 +120,11 @@ modparam("peering", "verify_destination_service_type", 21)
 		<title><varname>verify_source_service_type</varname> (integer)</title>
 		<para>
 		This is the value of the Service-Type Radius attribute to be
-		used, when receiver of SIP Request verifies request's
-	source using verify_source() function.
+		used, when receiver of SIP Request verifies the request's
+		source using verify_source() function.
 		</para>
 		<para>
-		Default value is dictionary value of <quote>Sip-Verify-Source</quote>
+		Default value is the dictionary value of <quote>Sip-Verify-Source</quote>
 		Service-Type.
 		</para>
 		<example>
@@ -145,8 +143,8 @@ modparam("peering", "verify_source_service_type", 22)
 		<para>
 		Function verify_destination() queries from
 		broker's Radius server if domain (host part) of Request
-	URI is served by a trusted peer.  Radius request contains the
-	following attributes/values:
+		URI is served by a trusted peer.  Radius request contains the
+		following attributes/values:
 		</para>
 		<itemizedlist>
 		<listitem>
@@ -167,22 +165,22 @@ modparam("peering", "verify_source_service_type", 22)
 		</itemizedlist>
 		<para>
 		Function returns value 1 if domain of Request URI is
-	served by a trusted peer and -1 otherwise.  In case of positive
-	result, Radius server returns a set of SIP-AVP reply attributes.
-	Value of each SIP-AVP is of form:
+		served by a trusted peer and -1 otherwise.  In case of positive
+		result, the Radius server returns a set of SIP-AVP reply attributes.
+		The value of each SIP-AVP is of form:
 		 </para>
 		 <para>
 		 [#]name(:|#)value
 		 </para>
 		 <para>
 		 Value of each SIP-AVP reply attribute is mapped to an
-		 Kamailio AVP.  Prefix # in front of name or value indicates a
-	string name or string value, respectively.
+		 &kamailio; AVP.  Prefix # in front of name or value indicates a
+		 string name or string value, respectively.
 		 </para>
 		 <para>
 		 One of the SIP-AVP reply attributes contains a string
 		 that the source peer must include "as is" in a 
-		 P-Request-Hash header when it sends the SIP request to
+		 <emphasis>P-Request-Hash:</emphasis> header when it sends the SIP request to
 		 the destination peer.  The string value may, for
 		 example, be of form hash@timestamp, where hash contains
 		 a hash calculated by the broker based on the attributes
@@ -212,10 +210,10 @@ if (verify_destination()) {
 	<section>
 		<title><function moreinfo="none">verify_source()</function></title>
 		<para>
-		Function verify_source() queries from
-		broker's Radius server if SIP request was received from
-	a trusted peer.  Radius request contains the
-	following attributes/values:
+		Function verify_source() queries the
+		broker's Radius server whether the SIP request was received from
+		a trusted peer.  The Radius request contains the
+		following attributes/values:
 		</para>
 		<itemizedlist>
 		<listitem>
@@ -239,18 +237,18 @@ if (verify_destination()) {
 		</itemizedlist>
 		<para>
 		Function returns value 1 if SIP request was received
-	from a trusted peer and -1 otherwise.  In case of positive
-	result, Radius server may return a set of SIP-AVP reply
-	attributes.  Value of each SIP-AVP is of form:
+		from a trusted peer and -1 otherwise.  In case of positive
+		result, Radius server may return a set of SIP-AVP reply
+		attributes.  Value of each SIP-AVP is of form:
 		 </para>
 		 <para>
 		 [#]name(:|#)value
 		 </para>
 		 <para>
 		 Value of each SIP-AVP reply attribute is mapped to an
-		 Kamailio 
+		 &kamailio; 
 		 AVP.  Prefix # in front of name or value indicates a
-	string name or string value, respectively.
+		string name or string value, respectively.
 		 </para>
 		 <para>
 		 AVP names used in reply attributes are