2
0
Эх сурвалжийг харах

corex: add section ids to docs

Daniel-Constantin Mierla 9 жил өмнө
parent
commit
cb41e0146a

+ 0 - 2
modules/corex/README

@@ -10,8 +10,6 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-Edited by
-
 Muhammad Shahzad Shafi
 Muhammad Shahzad Shafi
 
 
    <[email protected]>
    <[email protected]>

+ 15 - 15
modules/corex/doc/corex_admin.xml

@@ -73,7 +73,7 @@
 
 
     <section>
     <section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
+	<section id="corex.p.alias_subdomains">
 	    <title><varname>alias_subdomains</varname> (string)</title>
 	    <title><varname>alias_subdomains</varname> (string)</title>
 	    <para>
 	    <para>
 		Register a domain and all its sub-domains to match the <quote>myself</quote>
 		Register a domain and all its sub-domains to match the <quote>myself</quote>
@@ -96,7 +96,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 </programlisting>
 </programlisting>
 	    </example>
 	    </example>
 	</section>
 	</section>
-    <section>
+    <section id="corex.p.network_io_intercept">
         <title><varname>network_io_intercept</varname> (int)</title>
         <title><varname>network_io_intercept</varname> (int)</title>
         <para>
         <para>
             If set to non-zero then raw data received from a remote host or about to
             If set to non-zero then raw data received from a remote host or about to
@@ -118,7 +118,7 @@ modparam("corex", "network_io_intercept", 1)
 </programlisting>
 </programlisting>
         </example>
         </example>
     </section>
     </section>
-    <section>
+    <section id="corex.p.min_msg_len">
         <title><varname>min_msg_len</varname> (int)</title>
         <title><varname>min_msg_len</varname> (int)</title>
         <para>
         <para>
             Minimum content length of the packet to execute the event_route[network:msg].
             Minimum content length of the packet to execute the event_route[network:msg].
@@ -138,7 +138,7 @@ modparam("corex", "min_msg_len", 32)
 </programlisting>
 </programlisting>
         </example>
         </example>
     </section>
     </section>
-    <section>
+    <section id="corex.p.msg_avp">
         <title><varname>msg_avp</varname> (string)</title>
         <title><varname>msg_avp</varname> (string)</title>
         <para>
         <para>
             AVP name to store modified content to be set in the packet. If not set in
             AVP name to store modified content to be set in the packet. If not set in
@@ -163,7 +163,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
 
 
 	<section>
 	<section>
 	<title>Functions</title>
 	<title>Functions</title>
-	<section>
+	<section id="corex.f.append_branch">
 	    <title>
 	    <title>
 		<function moreinfo="none">append_branch([ uri, [ q ] ])</function>
 		<function moreinfo="none">append_branch([ uri, [ q ] ])</function>
 	    </title>
 	    </title>
@@ -205,7 +205,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
 	    </example>
 	    </example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="corex.f.send">
 		<title>
 		<title>
 			<function moreinfo="none">send([ host [ :port ] ])</function>
 			<function moreinfo="none">send([ host [ :port ] ])</function>
 		</title>
 		</title>
@@ -240,7 +240,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
 		</example>
 		</example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="corex.f.send_tcp">
 		<title>
 		<title>
 			<function moreinfo="none">send_tcp([ host [ :port ] ])</function>
 			<function moreinfo="none">send_tcp([ host [ :port ] ])</function>
 		</title>
 		</title>
@@ -251,7 +251,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
 		</para>
 		</para>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="corex.f.send_data">
 		<title>
 		<title>
 			<function moreinfo="none">send_data(uri, data)</function>
 			<function moreinfo="none">send_data(uri, data)</function>
 		</title>
 		</title>
@@ -272,14 +272,14 @@ modparam("corex", "msg_avp", "$avp(msg)")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-    <section>
+    <section id="corex.f.is_incoming">
 		<title>
 		<title>
 			<function moreinfo="none">is_incoming()</function>
 			<function moreinfo="none">is_incoming()</function>
 		</title>
 		</title>
         <para>
         <para>
             Returns true if contents of message buffer $mb are the data received from
             Returns true if contents of message buffer $mb are the data received from
             remote host, otherwise false indicating that the contents of $mb are data
             remote host, otherwise false indicating that the contents of $mb are data
-            that is about to be sent out to remote host. This only works if 
+            that is about to be sent out to remote host. This only works if
 			network_io_intercept parameter is set to non-zero.
 			network_io_intercept parameter is set to non-zero.
         </para>
         </para>
         <para>
         <para>
@@ -414,7 +414,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 
 
 	<section>
 	<section>
 	<title>RPC Commands</title>
 	<title>RPC Commands</title>
-	<section>
+	<section id="corex.rpc.list_sockets">
 		<title>
 		<title>
 		<function moreinfo="none">corex.list_sockets</function>
 		<function moreinfo="none">corex.list_sockets</function>
 		</title>
 		</title>
@@ -428,7 +428,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 		&sercmd; corex.list_sockets
 		&sercmd; corex.list_sockets
 		</programlisting>
 		</programlisting>
     </section>
     </section>
-	<section>
+	<section id="corex.rpc.list_aliases">
 		<title>
 		<title>
 		<function moreinfo="none">corex.list_aliases</function>
 		<function moreinfo="none">corex.list_aliases</function>
 		</title>
 		</title>
@@ -443,7 +443,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 		&sercmd; corex.list_aliases
 		&sercmd; corex.list_aliases
 		</programlisting>
 		</programlisting>
     </section>
     </section>
-	<section>
+	<section id="corex.rpc.shm_status">
 		<title>
 		<title>
 		<function moreinfo="none">corex.shm_status</function>
 		<function moreinfo="none">corex.shm_status</function>
 		</title>
 		</title>
@@ -457,7 +457,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 		&sercmd; corex.shm_status
 		&sercmd; corex.shm_status
 		</programlisting>
 		</programlisting>
 	</section>
 	</section>
-	<section>
+	<section id="corex.rpc.shm_summary">
 		<title>
 		<title>
 		<function moreinfo="none">corex.shm_summary</function>
 		<function moreinfo="none">corex.shm_summary</function>
 		</title>
 		</title>
@@ -471,7 +471,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 		&sercmd; corex.shm_summary
 		&sercmd; corex.shm_summary
 		</programlisting>
 		</programlisting>
     </section>
     </section>
-	<section>
+	<section id="corex.rpc.pkg_summary">
 		<title>
 		<title>
 		<function moreinfo="none">corex.pkg_summary</function>
 		<function moreinfo="none">corex.pkg_summary</function>
 		</title>
 		</title>