Merge pull request #881 from mslehto/doctypo
authorOlle E. Johansson <oej@edvina.net>
Sun, 4 Dec 2016 16:43:08 +0000 (17:43 +0100)
committerGitHub <noreply@github.com>
Sun, 4 Dec 2016 16:43:08 +0000 (17:43 +0100)
documentation fixes for various modules

cfg_parser.h
modules/corex/doc/corex_admin.xml
modules/db2_ops/doc/db2_ops.xml
modules/dispatcher/doc/dispatcher_admin.xml
modules/drouting/doc/drouting_admin.xml
modules/mohqueue/doc/mohqueue_admin.xml
modules/rtpproxy/doc/rtpproxy_admin.xml
modules/tm/doc/functions.xml
sr_module.h

index 5ca2065..1883563 100644 (file)
@@ -69,7 +69,7 @@ typedef enum cfg_flags {
        CFG_PREFIX = (1 << 3),
 
        /*! \brief The result of cfg_parse_str_val will be in a buffer allocated by
-        * pkg_malloc, if the destination varaiable contains a pointer to a buffer
+        * pkg_malloc, if the destination variable contains a pointer to a buffer
         * already then it will be freed with pkg_free first.
         */
        CFG_STR_PKGMEM = (1 << 4),
index b018b66..7db5c74 100644 (file)
@@ -522,7 +522,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
             the message for on-wire communication, e.g. to do custom encryption or
             decryption, compression/decompression etc. of the message sent to or 
                        received from remote host. Therefore, except text operations,
-                       no module fucntions or pseudo variables are available in this event route.
+                       no module functions or pseudo variables are available in this event route.
         </para>
     </section>
     </section>
index 95a1156..9e979f2 100644 (file)
                        </title>
                        <para>
                                Hack which enables using db_ops queries in failure route.
-                               Call it at the beginning of <emphasis>failure_route</emphasis> block.
+                               Call it at the beginning of FAILURE_ROUTE block.
                        </para>
                        <example>
                                <title><function>db_proper</function> usage</title>
index e92cec0..4b462bd 100644 (file)
@@ -1167,7 +1167,7 @@ if(ds_select("1", "$var(a)")) {
                                addition to one of the previous flags - the last destination
                                will be set to probing. This mean the destination will be pinged
                                with SIP OPTIONS requests from time to time to detect if it is
-                               up running or down.</para>
+                               up or down.</para>
                </listitem>
                </itemizedlist>
                <para>
index f3cffd9..e3769c0 100644 (file)
@@ -985,7 +985,7 @@ modparam("drouting", "sort_order", 2)
                <title><varname>ruri_avp</varname> (str)</title>
                <para>
                The name of the avp for storing Request URIs to be later used 
-               (alternative destiantions for the current one).
+               (alternative destinations for the current one).
                </para>
                <para>
                <emphasis>Default value is <quote>NULL</quote>.
index 3e53ee7..c589b73 100644 (file)
@@ -88,7 +88,7 @@ The URL to connect to the database for the mohqueue tables.
         <title>Set <varname>db_url</varname>:</title>
         <programlisting format="linespecific">
 ...
-modparam ("mohqueue", "db_url", "mysql://kamailio:kamailiorw@localhost/kamailio")
+modparam("mohqueue", "db_url", "mysql://kamailio:kamailiorw@localhost/kamailio")
 ...
         </programlisting>
       </example>
@@ -109,8 +109,8 @@ maintains the call status.
         <title>Set table names:</title>
         <programlisting format="linespecific">
 ...
-modparam ("mohqueue", "db_qtable", "mqueues")
-modparam ("mohqueue", "db_ctable", "mcalls")
+modparam("mohqueue", "db_qtable", "mqueues")
+modparam("mohqueue", "db_ctable", "mcalls")
 ...
         </programlisting>
       </example>
@@ -131,7 +131,7 @@ queues table.</emphasis>
         <title>Set default directory for audio files:</title>
         <programlisting format="linespecific">
 ...
-modparam ("mohqueue", "mohdir", "/var/kamailio/MOH")
+modparam("mohqueue", "mohdir", "/var/kamailio/MOH")
 ...
         </programlisting>
       </example>
@@ -154,7 +154,7 @@ queues table.</emphasis>
         <title>Set default directory for audio files:</title>
         <programlisting format="linespecific">
 ...
-modparam ("mohqueue", "mohdir", "/var/kamailio/MOH")
+modparam("mohqueue", "mohdir", "/var/kamailio/MOH")
 ...
         </programlisting>
       </example>
@@ -167,7 +167,7 @@ modparam ("mohqueue", "mohdir", "/var/kamailio/MOH")
 
     <section id="proc.func">
       <title>
-        <function moreinfo="none">mohq_process ()</function>
+        <function moreinfo="none">mohq_process()</function>
       </title>
       <para>
 Checks to see if the current SIP message involves a queue. If it
@@ -207,8 +207,8 @@ request_route {
   # main route with limited processing
 ...
   # MOH queue?
-  if (mohq_process ()) {
-    xlog ("L_DBG", "Handled by mohqueue");
+  if (mohq_process()) {
+    xlog("L_DBG", "Handled by mohqueue");
     exit;
   }
   # An error or not a MOH queue message; continue processing
@@ -221,12 +221,12 @@ request_route {
 
     <section id="send.func">
       <title>
-        <function moreinfo="none">mohq_send (queue_name)</function>
+        <function moreinfo="none">mohq_send(queue_name)</function>
       </title>
       <para>
 Normally calls enter the queue with an initial INVITE message that
 1) has a RURI that matches a queue URI and 2) is passed through
-<function>mohq_proc ()</function>, which is the preferred method.
+<function>mohq_process()</function>, which is the preferred method.
       </para>
       <para>
 This function is used when you wish to send a call into a queue that
@@ -254,8 +254,8 @@ can be passed as a literal or pseudo-variable.
 ...
   # call is initial INVITE and ready for queue?
   if (some test) {
-    if (mohq_send ("main")) {
-      xlog ("L_DBG", "Sent call to main mohqueue");
+    if (mohq_send("main")) {
+      xlog("L_DBG", "Sent call to main mohqueue");
       exit;
     }
     # failed to enter queue!
@@ -268,7 +268,7 @@ can be passed as a literal or pseudo-variable.
 
     <section id="retrieve.func">
       <title>
-        <function moreinfo="none">mohq_retrieve (queue_name, URI)</function>
+        <function moreinfo="none">mohq_retrieve(queue_name, URI)</function>
       </title>
       <para>
 Retrieves the oldest call in a queue and redirects it to a URI.
@@ -299,12 +299,11 @@ be called from any route.
 #!define CGROUP   "sip:operators@10.211.64.5"
 ...
   # redirect oldest call to operator call group
-  if (mohq_retrieve (MOHQNAME, CGROUP)) {
-      xlog ("L_DBG", "Retrieved call from mohqueue");
+  if (mohq_retrieve(MOHQNAME, CGROUP)) {
+      xlog("L_DBG", "Retrieved call from mohqueue");
       exit;
-    }
-  # queue is empty or something went wrong
   }
+  # queue is empty or something went wrong
 ...
         </programlisting>
       </example>
@@ -312,7 +311,7 @@ be called from any route.
 
     <section id="count.func">
       <title>
-        <function moreinfo="none">mohq_count (queue_name, pvar)</function>
+        <function moreinfo="none">mohq_count(queue_name, pvar)</function>
       </title>
       <para>
 Finds the number of calls that are in a queue. It will not count
@@ -342,9 +341,9 @@ any route.
 $var(mohq) = "operators";
 ...
   # more than 10 calls?
-  mohq_count ("$var(mohq)", "$var(mohqcnt)");
+  mohq_count("$var(mohq)", "$var(mohqcnt)");
   if ($var(mohqcnt) > 10) {
-    xlog ("L_WARN", "$var(mohq) queue has $var(mohqcnt) calls!");
+    xlog("L_WARN", "$var(mohq) queue has $var(mohqcnt) calls!");
   }
 ...
         </programlisting>
index fcbab3a..49178fb 100644 (file)
@@ -456,7 +456,7 @@ rtpproxy_offer();
                                So, for example if a SIP requests is processed with 'ie' flags, the corresponding
                                response must be processed with 'ie' flags.
                                </para><para>
-                               Note: As rtpproxy in bridge mode s per default asymmetric, you have to specify
+                               Note: As rtpproxy in bridge mode is asymmetric per default, you have to specify
                                the 'w' flag for clients behind NAT! See also above notes!
                                </para></listitem>
                                <listitem><para>
@@ -769,7 +769,7 @@ rtpproxy_manage();
 ...
     if (is_method("INVITE")) {
         rtpproxy_offer();
-        if (detect_hold()) {
+        if (is_audio_on_hold()) {
             rtpproxy_stream2uas("/var/rtpproxy/prompts/music_on_hold", "-1");
         } else {
             rtpproxy_stop_stream2uas();
index 4ad34fc..ddc7dd9 100644 (file)
@@ -787,8 +787,7 @@ route {
        <para>
                Returns true if the failure route is executed for a branch that did
                timeout. It can be used from 
-               <emphasis>failure_route</emphasis> and
-               <emphasis>branch-failure</emphasis> event route.
+               FAILURE_ROUTE and BRANCH_FAILURE_ROUTE event route.
        </para>
        <example>
            <title><function>t_branch_timeout</function> usage</title>
@@ -1289,7 +1288,7 @@ if (!t_next_contacts()) {
                was empty and thus there was
                nothing to do, and returns -1 in case of an error (see
                syslog).
-               This function can be used from a BRANCH_FAILURE event route.
+               This function can be used from a BRANCH_FAILURE_ROUTE event route.
                </para>
                <example>
                <title><function>t_next_contact_flow</function> usage</title>
index e42ccdf..2cbed65 100644 (file)
@@ -607,7 +607,7 @@ int get_int_fparam(int* dst, struct sip_msg* msg, fparam_t* param);
  * @param s_dst string destination
  * @param msg SIP message
  * @param param function parameters
- * @param flags flags to indicate destiantions
+ * @param flags flags to indicate destinations
  * @return 0 on success, 1 on error, e.g. cannot get value
  */
 int get_is_fparam(int* i_dst, str* s_dst, struct sip_msg* msg, fparam_t* param, unsigned int *flags);