浏览代码

Merge pull request #2238 from btriller/doc-fixes

Doc fixes
Daniel-Constantin Mierla 5 年之前
父节点
当前提交
8d5ea6fbbc

+ 17 - 12
src/modules/acc_json/doc/acc_json_admin.xml

@@ -69,7 +69,7 @@
 	<title><varname>acc_flag</varname> (integer)</title>
 		<para>
 		Request flag which needs to be set to account a transaction in acc_json.
-		See output_mqueue and output_syslog
+		See acc_output_mqueue and acc_output_syslog
 		</para>
 		<para>
 		Default value is not-set (no flag).
@@ -88,7 +88,7 @@ modparam("acc_json", "acc_flag", 2)
 		<title><varname>acc_missed_flag</varname> (integer)</title>
 		<para>
 		Request flag which needs to be set to account missed calls in acc_json.
-		See output_mqueue and output_syslog
+		See acc_output_mqueue and acc_output_syslog
 		</para>
 		<para>
 		Default value is not-set (no flag).
@@ -181,8 +181,8 @@ modparam("acc_json", "acc_time_format", "%Y/%m/%d %H:%M:%S")
 		</example>
 	</section>
 
-	<section id="acc_json.p.output_mqueue">
-		<title><varname>output_mqueue</varname> (integer)</title>
+	<section id="acc_json.p.acc_output_mqueue">
+		<title><varname>acc_output_mqueue</varname> (integer)</title>
 		<para>
                 Requires the mqueue module.
                 The acc module will queue json acc events in the specified mqueue.
@@ -195,13 +195,13 @@ modparam("acc_json", "acc_time_format", "%Y/%m/%d %H:%M:%S")
 		Default value is not-set mqueue will not be required.
 		</para>
 		<example>
-		<title>output_mqueue usage example</title>
+		<title>acc_output_mqueue usage example</title>
 		<programlisting format="linespecific">
 ...
 # example using json_mqueue/http_client to publish to NSQD
 max_while_loops=100000
 modparam("mqueue", "mqueue", "name=acc_events;size=100000")
-modparam("acc_json", "output_mqueue", "acc_events")
+modparam("acc_json", "acc_output_mqueue", "acc_events")
 modparam("acc_json", "acc_flag", 2)
 modparam("acc_json", "acc_extra", "caller_ip_port=$avp(caller_ip_port);")
 modparam("rtimer", "timer", "name=nsqt;interval=1;mode=1;")
@@ -234,8 +234,8 @@ route[RUN_ACC_PUBLISH] {
 		</example>
 	</section>	
 	
-	<section id="acc_json.p.output_syslog">
-		<title><varname>output_syslog</varname> (integer)</title>
+	<section id="acc_json.p.acc_output_syslog">
+		<title><varname>acc_output_syslog</varname> (integer)</title>
 		<para>
 		Control if the output of acc json should be sent to syslog.
                 This is not dependent on Kamailio global logging settings,
@@ -246,10 +246,10 @@ route[RUN_ACC_PUBLISH] {
 		Default value is not-set (no flag).
 		</para>
 		<example>
-		<title>output_syslog example</title>
+		<title>acc_output_syslog example</title>
 		<programlisting format="linespecific">
 ...
-modparam("acc_json", "output_syslog", 1)
+modparam("acc_json", "acc_output_syslog", 1)
 modparam("acc_json", "acc_log_level", 2)
 modparam("acc_json", "acc_log_facility", "LOG_DAEMON")
 ...
@@ -408,8 +408,13 @@ route[RUN_CDR_PUBLISH] {
 </programlisting>
 		</example>
 	</section>
-	
-<section id="acc_json.p.cdr_log_facility">
+	<section id="acc_json.p.cdr_output_syslog">
+		<title><varname>cdr_output_syslog</varname> (integer)</title>
+		<para>
+                The acc module will log json cdr events to syslog.
+		</para>
+	</section>
+	<section id="acc_json.p.cdr_log_facility">
 		<title><varname>cdr_log_facility</varname> (integer)</title>
 		<para>
 		Log facility to which accounting messages are issued to syslog.

+ 1 - 1
src/modules/tm/doc/params.xml

@@ -1440,7 +1440,7 @@ end
 	</section>
 
 	<section id="tm.p.event_callback_lres_sent">
-		<title><varname>event_callback_lres</varname> (str)</title>
+		<title><varname>event_callback_lres_sent</varname> (str)</title>
 		<para>
 			The name of the function in the kemi configuration file (embedded
 			scripting language such as Lua, Python, ...) to be executed instead

+ 21 - 1
src/modules/usrloc/doc/usrloc_admin.xml

@@ -456,6 +456,26 @@ modparam("usrloc", "instance_column", "myinstance")
 		</example>
 	</section>
 
+	<section id="usrloc.p.reg_id_column">
+		<title><varname>reg_id_column</varname> (string)</title>
+		<para>
+		Name of database table column containing the value for reg-id.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>reg_id</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>reg_id_column</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("usrloc", "reg_id_column", "r_id")
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="usrloc.p.server_id_column">
 		<title><varname>server_id_column</varname> (string)</title>
 		<para>
@@ -527,7 +547,7 @@ modparam("usrloc", "keepalive_column", "kalive")
 		</emphasis>
 		</para>
 		<example>
-		<title>Set <varname>partitioncolumn</varname> parameter</title>
+		<title>Set <varname>partition_column</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
 modparam("usrloc", "partition_column", "part")

+ 1 - 1
src/modules/websocket/doc/websocket_admin.xml

@@ -499,7 +499,7 @@ modparam("websocket", "timer_interval", 5)
 		</para>
 		<para><emphasis>Default value is 5.</emphasis></para>
 		<example>
-		<title>Set <varname>rm_timer_interval</varname>parameter</title>
+		<title>Set <varname>rm_delay_interval</varname>parameter</title>
 		<programlisting format="linespecific">
 ...
 modparam("websocket", "rm_delay_interval", 2)