[sr-dev] git:master:89c12e06: mohqueue: updated documentation

[Robert Boisvert]

Module: kamailio
Branch: master
Commit: 89c12e0615d16d34aa3a4ec902a00063f89d26cb
URL: https://github.com/kamailio/kamailio/commit/89c12e0615d16d34aa3a4ec902a00063f89d26cb

Author: Robert Boisvert <rdbprog at gmail.com>
Committer: Robert Boisvert <rdbprog at gmail.com>
Date: 2017-02-14T20:22:52-05:00

mohqueue: updated documentation

 - explicitly state default values for parameters
 - fix description of moh_maxcalls

---

Modified: src/modules/mohqueue/doc/mohqueue_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/89c12e0615d16d34aa3a4ec902a00063f89d26cb.diff
Patch: https://github.com/kamailio/kamailio/commit/89c12e0615d16d34aa3a4ec902a00063f89d26cb.patch

---

diff --git a/src/modules/mohqueue/doc/mohqueue_admin.xml b/src/modules/mohqueue/doc/mohqueue_admin.xml
index d44350d..851ed10 100644
--- a/src/modules/mohqueue/doc/mohqueue_admin.xml
+++ b/src/modules/mohqueue/doc/mohqueue_admin.xml
@@ -10,7 +10,7 @@
 <!-- Module Admin Guide -->
 
 <chapter xmlns:xi="http://www.w3.org/2001/XInclude">
-  <title>&adminguide;</title>
+  <title>Admin Guide</title>
 
   <section id="overview">
     <title>Overview</title>
@@ -82,7 +82,7 @@ http://www.b2bua.org/wiki/RTPproxy</ulink>).
 The URL to connect to the database for the mohqueue tables.
       </para>
       <para>
-<emphasis>Default value for Kamailio.</emphasis>
+<emphasis>Default is the same value used by Kamailio.</emphasis>
       </para>
       <example>
         <title>Set <varname>db_url</varname>:</title>
@@ -102,7 +102,7 @@ the queues and <varname>db_ctable</varname> is the table that
 maintains the call status.
       </para>
       <para>
-<emphasis>"MOHQUEUES" for <varname>db_qtable</varname> and
+<emphasis>Default is "MOHQUEUES" for <varname>db_qtable</varname> and
 "MOHQCALLS" for <varname>db_ctable</varname>.</emphasis>
       </para>
       <example>
@@ -124,7 +124,7 @@ are usually relative to this directory although the value can be
 overridden by a directory specified in the queues table.
       </para>
       <para>
-<emphasis>None. If not set by the module it must be defined in the
+<emphasis>Default is None. If not set by the module it must be defined in the
 queues table.</emphasis>
       </para>
       <example>
@@ -147,14 +147,13 @@ processing power of the server or the number of available rtpproxy
 ports.
       </para>
       <para>
-<emphasis>None. If not set by the module it must be defined in the
-queues table.</emphasis>
+<emphasis>Default value is 50.</emphasis>
       </para>
       <example>
-        <title>Set default directory for audio files:</title>
+        <title>Set maximum calls to 200.</title>
         <programlisting format="linespecific">
 ...
-modparam ("mohqueue", "mohdir", "/var/kamailio/MOH")
+modparam ("mohqueue", "moh_maxcalls", 200)
 ...
         </programlisting>
       </example>
@@ -515,7 +514,7 @@ payload types.
         <function moreinfo="none">mohqueue.debug</function>
       </title>
       <para>
-Turns <ulink url="#mohqueues.dbase">debugging</ulink> on or off for a queue. The first paramater is the queue name and the second is a number indicating whether debugging should be turned off or on (0=off, <>0=on).
+Turns <ulink url="#mohqueues.dbase">debugging</ulink> on or off for a queue. The first paramater is the queue name and the second is a number indicating whether debugging should be turned off or on (0=off, <>0=on).
       </para>
       <example>
         <title><function>rpc.debug</function> usage:</title>