ims_charging: docs: Fixed linebreaks in examples, regenerated README

modules/ims_charging/README

@@ -340,8 +340,9 @@ Chapter 1. Admin Guide
    Default value is 4096.
 
    Example 1.1.  hash_sizeparameter usage
-... modparam("ims_charging", "hash_size", 1024)
-        ...
+...
+modparam("ims_charging", "hash_size", 1024)
+...
 
 4.2.  interim_update_credits(int)
 
@@ -352,8 +353,9 @@ Chapter 1. Admin Guide
    Default value is 30.
 
    Example 1.2.  interim_update_creditsparameter usage
-... modparam("ims_charging",
-        "interim_update_credits", 600) ...
+...
+modparam("ims_charging", "interim_update_credits", 600)
+...
 
 4.3.  timer_buffer(int)
 
@@ -363,8 +365,9 @@ Chapter 1. Admin Guide
    Default value is 8.
 
    Example 1.3.  timer_bufferparameter usage
-... modparam("ims_charging", "timer_buffer", 10)
-        ...
+...
+modparam("ims_charging", "timer_buffer", 10)
+...
 
 4.4.  ro_forced_peer(string)
 
@@ -374,8 +377,9 @@ Chapter 1. Admin Guide
    Default value is ''.
 
    Example 1.4.  ro_forced_peerparameter usage
-... modparam("ims_charging", "ro_forced_peer",
-        "ocs.ims.smilecoms.com") ...
+...
+modparam("ims_charging", "ro_forced_peer", "ocs.ims.smilecoms.com")
+...
 
 4.5.  ro_auth_expiry(integer)
 
@@ -385,8 +389,9 @@ Chapter 1. Admin Guide
    Default value is 7200.
 
    Example 1.5.  ro_auth_expiryparameter usage
-... modparam("ims_charging", "ro_auth_expiry", 14400)
-        ...
+...
+modparam("ims_charging", "ro_auth_expiry", 14400)
+...
 
 4.6.  ro_auth_expiry(integer)
 
@@ -396,8 +401,9 @@ Chapter 1. Admin Guide
    Default value is 7200.
 
    Example 1.6.  ro_auth_expiryparameter usage
-... modparam("ims_charging", "ro_auth_expiry", 14400)
-        ...
+...
+modparam("ims_charging", "ro_auth_expiry", 14400)
+...
 
 4.7.  cdp_event_latency(integer)
 
@@ -407,8 +413,9 @@ Chapter 1. Admin Guide
    Default value is 1.
 
    Example 1.7.  cdp_event_latencyparameter usage
-... modparam("ims_charging", "cdp_event_latency", 1)
-        ...
+...
+modparam("ims_charging", "cdp_event_latency", 1)
+...
 
 4.8.  cdp_event_threshold(integer)
 
@@ -420,8 +427,9 @@ Chapter 1. Admin Guide
    Default value is 500.
 
    Example 1.8.  cdp_event_thresholdparameter usage
-... modparam("ims_charging", "cdp_event_threshold",
-        500) ...
+...
+modparam("ims_charging", "cdp_event_threshold", 500)
+...
 
 4.9.  cdp_event_latency_log(integer)
 
@@ -432,8 +440,9 @@ Chapter 1. Admin Guide
    Default value is 0.
 
    Example 1.9.  cdp_event_latency_logparameter usage
-... modparam("ims_charging", "cdp_event_latency_log",
-        1) ...
+...
+modparam("ims_charging", "cdp_event_latency_log", 1)
+...
 
 4.10.  origin_host(string)
 
@@ -442,8 +451,9 @@ Chapter 1. Admin Guide
    Default value is "scscf.ims.smilecoms.com".
 
    Example 1.10.  origin_hostparameter usage
-... modparam("ims_charging", "origin_host",
-        "scscf.kamailio-ims.org") ...
+...
+modparam("ims_charging", "origin_host", "scscf.kamailio-ims.org")
+...
 
 4.11.  origin_realm(string)
 
@@ -452,8 +462,9 @@ Chapter 1. Admin Guide
    Default value is "ims.smilecome.com".
 
    Example 1.11.  origin_realmparameter usage
-... modparam("ims_charging", "origin_realm",
-        "kamailio-ims.org") ...
+...
+modparam("ims_charging", "origin_realm", "kamailio-ims.org")
+...
 
 4.12.  destination_host(string)
 
@@ -462,8 +473,9 @@ Chapter 1. Admin Guide
    Default value is 5s.
 
    Example 1.12.  destination_hostparameter usage
-... modparam("ims_charging", "destination_host",
-        "ocs.kamailio-ims.org") ...
+...
+modparam("ims_charging", "destination_host", "ocs.kamailio-ims.org")
+...
 
 4.13.  destination_realm(string)
 
@@ -472,8 +484,9 @@ Chapter 1. Admin Guide
    Default value is "ims.smilecoms.com".
 
    Example 1.13.  destination_realmparameter usage
-... modparam("ims_charging", "destination_realm",
-        "kamailio-ims.org") ...
+...
+modparam("ims_charging", "destination_realm", "kamailio-ims.org")
+...
 
 4.14.  service_context_id_root(string)
 
@@ -487,8 +500,7 @@ Chapter 1. Admin Guide
    provider, by the service element manufacturer, or by a standardization
    body, and MUST uniquely identify a given Diameter credit-control
    service specific document. The format of the Service-Context-Id is:
-"service-context" "@" "domain" service-context =
-      Token
+"service-context" "@" "domain" service-context = Token
 
    The Token is an arbitrary string of characters and digits.
 
@@ -508,8 +520,9 @@ Chapter 1. Admin Guide
    Default value is "[email protected]".
 
    Example 1.14.  service_context_id_rootparameter usage
-... modparam("ims_charging",
-        "service_context_id_root", "[email protected]") ...
+...
+modparam("ims_charging", "service_context_id_root", "[email protected]")
+...
 
 4.15.  service_context_id_ext(string)
 
@@ -519,8 +532,9 @@ Chapter 1. Admin Guide
    Default value is "ext".
 
    Example 1.15.  service_context_id_extparameter usage
-... modparam("ims_charging",
-        "service_context_id_ext", "ext2") ...
+...
+modparam("ims_charging", "service_context_id_ext", "ext2")
+...
 
 4.16.  service_context_id_mnc(string)
 
@@ -530,8 +544,9 @@ Chapter 1. Admin Guide
    Default value is "01".
 
    Example 1.16.  service_context_id_mncparameter usage
-... modparam("ims_charging",
-        "service_context_id_mnc", "42") ...
+...
+modparam("ims_charging", "service_context_id_mnc", "42")
+...
 
 4.17.  service_context_id_mcc(string)
 
@@ -544,8 +559,9 @@ Chapter 1. Admin Guide
    Default value is "001".
 
    Example 1.17.  service_context_id_mccparameter usage
-... modparam("ims_charging",
-        "service_context_id_mcc", "262") ...
+...
+modparam("ims_charging", "service_context_id_mcc", "262")
+...
 
 4.18.  service_context_id_release(string)
 
@@ -555,8 +571,9 @@ Chapter 1. Admin Guide
    Default value is "8" (Release 8).
 
    Example 1.18.  service_context_id_releaseparameter usage
-... modparam("ims_charging",
-        "service_context_id_release", "262") ...
+...
+modparam("ims_charging", "service_context_id_release", "262")
+...
 
 5. Functions
 
@@ -586,21 +603,34 @@ reservation_units)
    return value.
 
    Example 1.19. Ro_CCR
-... xlog("L_DBG","Sending initial CCR Request for
-        call\n"); Ro_CCR("CHARGING_CCR_REPLY", "orig", "SCUR", "", "30"); }
-        route[CHARGING_CCR_REPLY] { xlog("L_DBG","cca_return code is $avp(s:cca_
-return_code)\n");
-        switch ($avp(s:cca_return_code)){ case 1: #success xlog("L_DBG", "CCR su
-ccess - will route
-        message\n"); route(Finalize_Orig); break; case -1: #failure xlog("L_ERR"
-, "CCR failure -
-        error response sent from module\n"); sl_send_reply("402","Payment requir
-ed"); break; case
-        -2: #error xlog("L_ERR", "CCR error - error response sent from module\n"
-);
-        sl_send_reply("500", "Charging Error"); break; default: xlog("L_ERR", "U
-nknown return code
-        from CCR: [$avp(s:cca_return_code)] \n"); break; } exit; } ...
+...
+  xlog("L_DBG","Sending initial CCR Request for call\n");
+  Ro_CCR("CHARGING_CCR_REPLY", "orig", "SCUR", "", "30");
+}
+
+route[CHARGING_CCR_REPLY]
+  xlog("L_DBG","cca_return code is $avp(s:cca_return_code)\n");
+  switch ($avp(s:cca_return_code)) {
+    case 1: #success
+        xlog("L_DBG", "CCR success - will route message\n");
+        route(Finalize_Orig);
+        break;
+    case -1: #failure
+        xlog("L_ERR", "CCR failure - error response sent from module\n");
+        sl_send_reply("402","Payment required");
+        break;
+    case -2: #error
+        xlog("L_ERR", "CCR error - error response sent from module\n");
+        sl_send_reply("500", "Charging Error");
+        break;
+    default:
+        xlog("L_ERR", "Unknown return code from CCR: [$avp(s:cca_return_code)] \
+n");
+        break;
+  }
+  exit;
+  }
+...
 
 6. Statistics
 

modules/ims_charging/doc/ims_charging_admin.xml

@@ -185,8 +185,11 @@
       <example>
         <title>
         <varname>hash_size</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "hash_size", 1024)
-        ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "hash_size", 1024)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -201,8 +204,11 @@
       <example>
         <title>
         <varname>interim_update_credits</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "interim_update_credits", 600) ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "interim_update_credits", 600)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -215,8 +221,11 @@
       <example>
         <title>
         <varname>timer_buffer</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "timer_buffer", 10)
-        ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "timer_buffer", 10)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -230,8 +239,11 @@
       <example>
         <title>
         <varname>ro_forced_peer</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "ro_forced_peer",
-        "ocs.ims.smilecoms.com") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "ro_forced_peer", "ocs.ims.smilecoms.com")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -244,8 +256,11 @@
       <example>
         <title>
         <varname>ro_auth_expiry</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "ro_auth_expiry", 14400)
-        ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "ro_auth_expiry", 14400)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -258,8 +273,11 @@
       <example>
         <title>
         <varname>ro_auth_expiry</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "ro_auth_expiry", 14400)
-        ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "ro_auth_expiry", 14400)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -273,8 +291,11 @@
       <example>
         <title>
         <varname>cdp_event_latency</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "cdp_event_latency", 1)
-        ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "cdp_event_latency", 1)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -289,8 +310,11 @@
       <example>
         <title>
         <varname>cdp_event_threshold</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "cdp_event_threshold",
-        500) ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "cdp_event_threshold", 500)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -305,8 +329,11 @@
       <example>
         <title>
         <varname>cdp_event_latency_log</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "cdp_event_latency_log",
-        1) ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "cdp_event_latency_log", 1)
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -319,8 +346,11 @@
       <example>
         <title>
         <varname>origin_host</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "origin_host",
-        "scscf.kamailio-ims.org") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "origin_host", "scscf.kamailio-ims.org")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -333,8 +363,11 @@
       <example>
         <title>
         <varname>origin_realm</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "origin_realm",
-        "kamailio-ims.org") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "origin_realm", "kamailio-ims.org")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -347,8 +380,11 @@
       <example>
         <title>
         <varname>destination_host</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "destination_host",
-        "ocs.kamailio-ims.org") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "destination_host", "ocs.kamailio-ims.org")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -361,8 +397,11 @@
       <example>
         <title>
         <varname>destination_realm</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging", "destination_realm",
-        "kamailio-ims.org") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "destination_realm", "kamailio-ims.org")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -376,8 +415,9 @@
       service provider, by the service element manufacturer, or by a standardization body, and MUST
       uniquely identify a given Diameter credit-control service specific document. The format of
       the Service-Context-Id is:</para>
-      <programlisting format="linespecific">"service-context" "@" "domain" service-context =
-      Token</programlisting>
+      <programlisting format="linespecific">
+"service-context" "@" "domain" service-context = Token
+      </programlisting>
       <para>The Token is an arbitrary string of characters and digits.</para>
       <para>'domain' represents the entity that allocated the Service-Context-Id. It can be
       ietf.org, 3gpp.org, etc., if the identifier is allocated by a standardization body, or it can
@@ -394,8 +434,11 @@
       <example>
         <title>
         <varname>service_context_id_root</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "service_context_id_root", "[email protected]") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "service_context_id_root", "[email protected]")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -409,8 +452,11 @@
       <example>
         <title>
         <varname>service_context_id_ext</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "service_context_id_ext", "ext2") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "service_context_id_ext", "ext2")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -424,8 +470,11 @@
       <example>
         <title>
         <varname>service_context_id_mnc</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "service_context_id_mnc", "42") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "service_context_id_mnc", "42")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -440,8 +489,11 @@
       <example>
         <title>
         <varname>service_context_id_mcc</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "service_context_id_mcc", "262") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "service_context_id_mcc", "262")
+...
+        </programlisting>
       </example>
     </section>
     <section>
@@ -454,8 +506,11 @@
       <example>
         <title>
         <varname>service_context_id_release</varname>parameter usage</title>
-        <programlisting format="linespecific">... modparam("ims_charging",
-        "service_context_id_release", "262") ...</programlisting>
+        <programlisting format="linespecific">
+...
+modparam("ims_charging", "service_context_id_release", "262")
+...
+        </programlisting>
       </example>
     </section>
   </section>
@@ -500,15 +555,35 @@
       value.</para>
       <example>
         <title>Ro_CCR</title>
-        <programlisting format="linespecific">... xlog("L_DBG","Sending initial CCR Request for
-        call\n"); Ro_CCR("CHARGING_CCR_REPLY", "orig", "SCUR", "", "30"); }
-        route[CHARGING_CCR_REPLY] { xlog("L_DBG","cca_return code is $avp(s:cca_return_code)\n");
-        switch ($avp(s:cca_return_code)){ case 1: #success xlog("L_DBG", "CCR success - will route
-        message\n"); route(Finalize_Orig); break; case -1: #failure xlog("L_ERR", "CCR failure -
-        error response sent from module\n"); sl_send_reply("402","Payment required"); break; case
-        -2: #error xlog("L_ERR", "CCR error - error response sent from module\n");
-        sl_send_reply("500", "Charging Error"); break; default: xlog("L_ERR", "Unknown return code
-        from CCR: [$avp(s:cca_return_code)] \n"); break; } exit; } ...</programlisting>
+        <programlisting format="linespecific">
+...
+  xlog("L_DBG","Sending initial CCR Request for call\n");
+  Ro_CCR("CHARGING_CCR_REPLY", "orig", "SCUR", "", "30");
+}
+
+route[CHARGING_CCR_REPLY] 
+  xlog("L_DBG","cca_return code is $avp(s:cca_return_code)\n");
+  switch ($avp(s:cca_return_code)) {
+    case 1: #success
+        xlog("L_DBG", "CCR success - will route message\n");
+        route(Finalize_Orig);
+        break;
+    case -1: #failure
+        xlog("L_ERR", "CCR failure - error response sent from module\n");
+        sl_send_reply("402","Payment required");
+        break;
+    case -2: #error
+        xlog("L_ERR", "CCR error - error response sent from module\n");
+        sl_send_reply("500", "Charging Error");
+        break;
+    default:
+        xlog("L_ERR", "Unknown return code from CCR: [$avp(s:cca_return_code)] \n");
+        break;
+  }
+  exit;
+  }
+...
+        </programlisting>
       </example>
     </section>
   </section>