From 022fa0cfc75d150fde219b8ae4f9a99b3fa2f132 Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Fri, 3 Feb 2023 09:38:26 +0100 Subject: [PATCH] rr: doc - fixed typos and use the proper param name add_username instead of enable_username --- src/modules/rr/doc/rr_admin.xml | 8 ++++---- src/modules/rr/doc/rr_devel.xml | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml index 691e3d07df8..2456450e4fa 100644 --- a/src/modules/rr/doc/rr_admin.xml +++ b/src/modules/rr/doc/rr_admin.xml @@ -12,7 +12,7 @@
Overview - The module contains record routing logic + The module contains record routing logic.
@@ -20,7 +20,7 @@ &kamailio; is basically only a transaction stateful proxy, without any dialog support build in. There are many - features/services which actually requires a dialog awareness, like storing + features/services which actually require a dialog awareness, like storing the information in the dialog creation stage, information which will be used during the whole dialog existence. @@ -246,7 +246,7 @@ modparam("rr", "enable_socket_mismatch_warning", 0)
<varname>custom_user_avp</varname> (avp string) - When enable_username is enabled, a call to record_route will add + When add_username is enabled, a call to record_route will add the username of the RequestURI to the Record-Route URI. This parameter allows you to setup an AVP with which you can customise the username to be added in the Record-Route URI. @@ -664,7 +664,7 @@ add_rr_param(";nat=yes"); The function checks if the URI parameters of the local Route header (corresponding to the local server) matches the given regular - expression. It must be call after loose_route() (see ). Meaning of the parameters is as follows: diff --git a/src/modules/rr/doc/rr_devel.xml b/src/modules/rr/doc/rr_devel.xml index 516eb5a3aab..aa6f9c4b69d 100644 --- a/src/modules/rr/doc/rr_devel.xml +++ b/src/modules/rr/doc/rr_devel.xml @@ -128,7 +128,7 @@ record_route_advertised_address("1.2.3.4:5090"); The function checks for the request msg if the URI parameters of the local Route header (corresponding to the local server) matches the given regular expression re. - It must be call after the loose_route was done. + It must be called after the loose_route was done. The function returns 0 on success. Otherwise, -1 is returned. @@ -157,7 +157,7 @@ record_route_advertised_address("1.2.3.4:5090"); msg. As for checking it's used the ftag Route header parameter, the append_fromtag (see module parameter - must be enables. Also this must be call only after the loose_route is + must be enables. Also this must be called only after the loose_route is done. @@ -185,9 +185,9 @@ record_route_advertised_address("1.2.3.4:5090"); get_route_param(msg, name, val) - The function search in to the msg's Route header + The function searches in the msg's Route header parameters the parameter called name and returns its - value into val. It must be call only after the + value into val. It must be called only after the loose_route is done. @@ -220,7 +220,7 @@ record_route_advertised_address("1.2.3.4:5090"); register_rrcb(callback, param) - The function register a new callback (along with its parameter). The + The function registers a new callback (along with its parameter). The callback will be called when a loose route will be performed for the local address.