[sr-dev] git:5.1:9d301849: modules: readme files regenerated - modules ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: 5.1
Commit: 9d301849a145e89d2c82a7195234232e032fb8fb
URL: https://github.com/kamailio/kamailio/commit/9d301849a145e89d2c82a7195234232e032fb8fb

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2018-12-04T09:46:31+01:00

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

---

Modified: src/modules/ims_charging/README
Modified: src/modules/topos/README
Modified: src/modules/websocket/README

---

Diff:  https://github.com/kamailio/kamailio/commit/9d301849a145e89d2c82a7195234232e032fb8fb.diff
Patch: https://github.com/kamailio/kamailio/commit/9d301849a145e89d2c82a7195234232e032fb8fb.patch

---

diff --git a/src/modules/ims_charging/README b/src/modules/ims_charging/README
index 2d26fbaa4f..15941a0dfa 100644
--- a/src/modules/ims_charging/README
+++ b/src/modules/ims_charging/README
@@ -66,7 +66,7 @@ Carlos Ruiz Diaz
         5. Functions
 
               5.1. Ro_CCR(route_name, direction, reservation_units,
-                      domain, incoming_trunk_id, outgoing_trunk_id
+                      incoming_trunk_id, outgoing_trunk_id)
 
               5.2. Ro_set_session_id_avp()
 
@@ -163,8 +163,8 @@ Chapter 1. Admin Guide
 
    5. Functions
 
-        5.1. Ro_CCR(route_name, direction, reservation_units, domain,
-                incoming_trunk_id, outgoing_trunk_id
+        5.1. Ro_CCR(route_name, direction, reservation_units,
+                incoming_trunk_id, outgoing_trunk_id)
 
         5.2. Ro_set_session_id_avp()
 
@@ -689,13 +689,13 @@ modparam("ims_charging", "custom_user_avp", "$avp(from_user)")
 
 5. Functions
 
-   5.1. Ro_CCR(route_name, direction, reservation_units, domain,
-          incoming_trunk_id, outgoing_trunk_id
+   5.1. Ro_CCR(route_name, direction, reservation_units,
+          incoming_trunk_id, outgoing_trunk_id)
 
    5.2. Ro_set_session_id_avp()
 
-5.1. Ro_CCR(route_name, direction, reservation_units, domain,
-incoming_trunk_id, outgoing_trunk_id
+5.1. Ro_CCR(route_name, direction, reservation_units, incoming_trunk_id,
+outgoing_trunk_id)
 
    Perform a CCR on Diameter Ro interface for Charging
 
@@ -704,7 +704,6 @@ incoming_trunk_id, outgoing_trunk_id
      * direction "orig"inating or "term"inating
      * reservation_units how many units (at the moment seconds) should be
        reservated at the moment.
-     * domain Logical domain within registrar.
      * incoming_trunk_id Identifies the trunk group from which this
        originates.
      * outgoing_trunk_id Identifies the trunk group where this will be
diff --git a/src/modules/topos/README b/src/modules/topos/README
index c921117131..a9bd0d8327 100644
--- a/src/modules/topos/README
+++ b/src/modules/topos/README
@@ -161,7 +161,7 @@ modparam("topos", "mask_callid", 1)
 
 3.4. sanity_checks (int)
 
-   If set to 1, topoh module will bind to sanity module in order to
+   If set to 1, topos module will bind to sanity module in order to
    perform sanity checks over received SIP request. Default sanity checks
    are done. It is useful to check if received request is well formated
    before proceeding to encoding/decoding.
@@ -170,7 +170,7 @@ modparam("topos", "mask_callid", 1)
 
    Example 1.4. Set sanity_checks parameter
 ...
-modparam("topoh", "sanity_checks", 1)
+modparam("topos", "sanity_checks", 1)
 ...
 
 3.5. branch_expire (int)
diff --git a/src/modules/websocket/README b/src/modules/websocket/README
index 158248654a..6421646e09 100644
--- a/src/modules/websocket/README
+++ b/src/modules/websocket/README
@@ -203,7 +203,7 @@ event_route[xhttp:request] {
                 # Optional... perform HTTP authentication
 
                 # ws_handle_handshake() exits (no further configuration file
-                # processing of the request) when complete.
+                # processing of the request) when complete in case of failure.
                 if (ws_handle_handshake())
                 {
                         # Optional... cache some information about the
@@ -500,7 +500,8 @@ end
 Note
 
    This function returns 0, stopping all further processing of the
-   request, when there is a problem.
+   request, when there is a problem. Otherwise, it returns 1 (or positive
+   number) in case of success.
 
    Example 1.12. ws_handle_handshake usage
 ...