Improve documentation

    * sql_cacher: fix grammar
    * rtpproxy: improve function signatures (each param is optional)
    * fix typos

(cherry picked from commit 03c910b)

async.h

@@ -31,7 +31,7 @@
 #include "parser/msg_parser.h"
 
 
-/* The possible values of the status of async operatations (as reported by
+/* The possible values of the status of async operations (as reported by
  * module functions, at start and resume)
  * NOTE: all values in this enum must be negative
  */

etc/opensips.cfg

@@ -99,7 +99,7 @@ loadmodule "acc.so"
 modparam("acc", "early_media", 0)
 modparam("acc", "report_cancels", 0)
 /* by default we do not adjust the direct of the sequential requests.
-   if you enable this parameter, be sure the enable "append_fromtag"
+   if you enable this parameter, be sure to enable "append_fromtag"
    in "rr" module */
 modparam("acc", "detect_direction", 0)
 

modules/rtpproxy/doc/rtpproxy_admin.xml

@@ -469,8 +469,8 @@ modparam("rtpproxy", "rtpp_notify_socket", "tcp:10.10.10.10:9999")
 	<title>Exported Functions</title>
 	<section>
 		<title>
-			<function moreinfo="none">engage_rtp_proxy([flags [, ip_address [, set_id [, sock_pvar]]]]) - deprecated</function>,
-			<function moreinfo="none">rtpproxy_engage([flags [, ip_address [, set_id [, sock_pvar]]]])</function>
+			<function moreinfo="none">engage_rtp_proxy([[flags][, [ip_address][, [set_id][, sock_pvar]]]]) - deprecated</function>,
+			<function moreinfo="none">rtpproxy_engage([[flags][, [ip_address][, [set_id][, sock_pvar]]]])</function>
 		</title>
 
 		<para>
@@ -599,7 +599,7 @@ if (is_method("INVITE") &amp;&amp; has_totag()) {
 
         <section>
                 <title>
-                <function moreinfo="none">rtpproxy_offer([flags [, ip_address [, set_id [, sock_pvar]]]])</function>
+                <function moreinfo="none">rtpproxy_offer([[flags][, [ip_address][, [set_id][, sock_pvar]]])</function>
                 </title>
                 <para>
                 Rewrites &sdp; body to ensure that media is passed through
@@ -653,7 +653,7 @@ onreply_route[2]
 	</section>
         <section>
                 <title>
-                <function moreinfo="none">rtpproxy_answer([flags [, ip_address [, set_id [, sock_pvar]]]])</function>
+                <function moreinfo="none">rtpproxy_answer([[flags][, [ip_address][, [set_id][, sock_pvar]]]])</function>
                 </title>
 		<para>
 		Rewrites &sdp; body to ensure that media is passed through
@@ -678,8 +678,8 @@ onreply_route[2]
         </section>
 	<section>
 		<title>
-		<function moreinfo="none">unforce_rtp_proxy([set_id [, sock_pvar]]) - deprecated</function>,
-		<function moreinfo="none">rtpproxy_unforce([set_id [, sock_pvar]])</function>
+		<function moreinfo="none">unforce_rtp_proxy([[set_id][, sock_pvar]]) - deprecated</function>,
+		<function moreinfo="none">rtpproxy_unforce([[set_id][, sock_pvar]])</function>
 		</title>
 		<para>
 		Tears down the RTPProxy session for the current call.
@@ -708,8 +708,8 @@ rtpproxy_unforce();
 	</section>
 	<section id="rtpproxy_stream2xxx">
 	<title>
-	    <function>rtpproxy_stream2uac(prompt_name, count [, set_id [, sock_pvar]])</function>,
-	    <function>rtpproxy_stream2uas(prompt_name, count [, set_id [, sock_pvar]])</function>
+	    <function>rtpproxy_stream2uac(prompt_name, count[, [set_id][, sock_pvar]])</function>,
+	    <function>rtpproxy_stream2uas(prompt_name, count[, [set_id][, sock_pvar]])</function>
 	</title>
 	<para>
 	    Instruct the RTPproxy to stream prompt/announcement pre-encoded with
@@ -780,8 +780,8 @@ rtpproxy_unforce();
 	</section>
 	<section id="rtpproxy_stop_stream2xxx">
 	<title>
-	    <function>rtpproxy_stop_stream2uac([set_id [, sock_pvar]])</function>,
-	    <function>rtpproxy_stop_stream2uas([set_id [, sock_pvar]])</function>
+	    <function>rtpproxy_stop_stream2uac([[set_id][, sock_pvar]])</function>,
+	    <function>rtpproxy_stop_stream2uas([[set_id][, sock_pvar]])</function>
 	</title>
 	<para>
 	    Stop streaming of announcement/prompt/MOH started previously by the
@@ -805,8 +805,8 @@ rtpproxy_unforce();
 	</section>
 	<section>
 		<title>
-		<function moreinfo="none">start_recording([set_id [, sock_pvar]]) - deprecated</function>,
-		<function moreinfo="none">rtpproxy_start_recording([set_id [, sock_pvar]])</function>
+		<function moreinfo="none">start_recording([[set_id][, sock_pvar]]) - deprecated</function>,
+		<function moreinfo="none">rtpproxy_start_recording([[set_id][, sock_pvar]])</function>
 		</title>
 		<para>
 		This command will send a signal to the RTP-Proxy to record 

modules/sql_cacher/doc/sql_cacher_admin.xml

@@ -65,7 +65,7 @@
 		</para>
 		<para>
 		The caching entry is specified via this parameter that has it's own
-		subparameters. Each of those parameters are separted a
+		subparameters. Each of those parameters are separated by a
 		delimiter configured by <xref linkend="param_spec_delimiter"/>
 		and have the following format:
 		<para><emphasis>param_name=param_value</emphasis></para>
@@ -135,7 +135,7 @@ on_demand=0")
 	    </example>
 	</section>
 
-	<section>
+	<section id="param_spec_delimiter" xreflabel="spec_delimiter">
 		<title><varname>spec_delimiter</varname> (string)</title>
 		<para>
 		The delimiter to be used in the caching entry specification provided in the
@@ -155,7 +155,7 @@ modparam("sql_cacher", "spec_delimiter", "\n")
 	    </example>
 	</section>
 
-	<section>
+	<section id="param_pvar_delimiter" xreflabel="pvar_delimiter">
 		<title><varname>pvar_delimiter</varname> (string)</title>
 		<para>
 		The delimiter to be used in the <quote>$sql_cached_value</quote>
@@ -175,7 +175,7 @@ modparam("sql_cacher", "pvar_delimiter", " ")
 	    </example>
 	</section>
 
-	<section>
+	<section id="param_columns_delimiter" xreflabel="columns_delimiter">
 		<title><varname>columns_delimiter</varname> (string)</title>
 		<para>
 		The delimiter to be used in the <emphasis>columns</emphasis> subparameter of
@@ -239,7 +239,7 @@ modparam("sql_cacher", "full_caching_expire", 3600)
 		<title><varname>reload_interval</varname> (integer)</title>
 		<para>
 		This parameter represents how many seconds before the data expires (for full caching) the
-		automatic reloading is triggerd.
+		automatic reloading is triggered.
 		</para>
 		<para>
 		The default value is <quote>60 s</quote>.