Browse code

modules: readme files regenerated - rr ... [skip ci]

Kamailio Dev authored on 23/03/2018 07:47:09
Showing 1 changed files
... ...
@@ -169,8 +169,8 @@ Chapter 1. Admin Guide
169 169
    3261 (see 12.1.1 UAS behavior).
170 170
 
171 171
    For this purpose, the modules offers the following functions:
172
-     * add_rr_param() - see Section 5.6, “add_rr_param(param)”
173
-     * check_route_param() - see Section 5.7, “check_route_param(re)”
172
+     * add_rr_param() - see ???
173
+     * check_route_param() - see ???
174 174
 
175 175
    Example 1.1. Dialog support in RR module
176 176
 ...
... ...
@@ -496,9 +496,8 @@ record_route_advertised_address("1.2.3.4:5080");
496 496
 
497 497
    Adds a parameter to the Record-Route URI (param must be in
498 498
    “;name=value” format. The function may be called also before or after
499
-   the record_route() or record_route_advertised_address() calls (see
500
-   Section 5.2, “record_route() and record_route(string)” or Section 5.5,
501
-   “record_route_advertised_address(address)”)).
499
+   the record_route() or record_route_advertised_address() calls (see ???
500
+   or ???)).
502 501
 
503 502
    Meaning of the parameters is as follows:
504 503
      * param - String containing the URI parameter to be added. It must
... ...
@@ -516,8 +515,7 @@ add_rr_param(";nat=yes");
516 515
 
517 516
    The function checks if the URI parameters of the local Route header
518 517
    (corresponding to the local server) matches the given regular
519
-   expression. It must be call after loose_route() (see Section 5.1,
520
-   “loose_route()”).
518
+   expression. It must be call after loose_route() (see ???).
521 519
 
522 520
    Meaning of the parameters is as follows:
523 521
      * re - regular expression to check against the Route URI parameters.
... ...
@@ -535,9 +533,8 @@ if (check_route_param("nat=yes")) {
535 533
 
536 534
    The function checks the flow direction of in-dialog requests. This
537 535
    function uses the “ftag” parameter from the Route header, therefore the
538
-   append_fromtag (see Section 4.2, “append_fromtag (integer)” module
539
-   parameter must be enabled. Also this must be called only after
540
-   loose_route() (see Section 5.1, “loose_route()”).
536
+   append_fromtag (see ??? module parameter must be enabled. Also this
537
+   must be called only after loose_route() (see ???).
541 538
 
542 539
    The function returns true if the “dir” is the same with the request's
543 540
    flow direction.
... ...
@@ -679,9 +676,8 @@ record_route_advertised_address("1.2.3.4:5090");
679 676
 
680 677
    The function checks the flow direction of the request “msg”. As for
681 678
    checking it's used the “ftag” Route header parameter, the
682
-   append_fromtag (see Section 4.2, “append_fromtag (integer)” module
683
-   parameter must be enables. Also this must be call only after the
684
-   loose_route is done.
679
+   append_fromtag (see ??? module parameter must be enables. Also this
680
+   must be call only after the loose_route is done.
685 681
 
686 682
    The function returns 0 if the “dir” is the same with the request's flow
687 683
    direction. Otherwise, -1 is returned.