[sr-dev] git:master: app_java: minor doc updates

Olle E. Johansson oej at edvina.net
Thu Sep 25 22:01:26 CEST 2014 

Module: sip-router
Branch: master
Commit: 820998136ffda07b607bc9833c340b6b62e24219
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=820998136ffda07b607bc9833c340b6b62e24219

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Thu Sep 25 22:00:45 2014 +0200

app_java: minor doc updates

- Added section ID's

---

 modules/app_java/README                 |   26 +++++++++++++-------------
 modules/app_java/doc/app_java_admin.xml |   25 +++++++++++++------------
 2 files changed, 26 insertions(+), 25 deletions(-)

diff --git a/modules/app_java/README b/modules/app_java/README
index d7fd0fc..f2aff39 100644
--- a/modules/app_java/README
+++ b/modules/app_java/README
@@ -6,7 +6,7 @@ Edited by
 
 Konstantin Mosesov
 
-   Copyright © 2013, 2014 Konstantin Mosesov
+   Copyright © 2013, 2014 Konstantin Mosesov
      __________________________________________________________________
 
    Table of Contents
@@ -114,9 +114,9 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module allows executing Java compiled classes from config file,
-   exporting functions to access the SIP message from Java using Java
-   Native Interface (JNI).
+   This module allows execution of Java compiled classes from the Kamailio
+   config file, exporting functions to access the SIP message from Java
+   using the Java Native Interface (JNI).
 
 2. Dependencies
 
@@ -174,7 +174,7 @@ Chapter 1. Admin Guide
    The class name should have the same compiled file name. If the value is
    "Kamailio", then the compiled file should be named as "Kamailio.class".
 
-   Default value is “Kamailio”.
+   Default value is "Kamailio".
 
    Example 1.1. Set class_name parameter
 ...
@@ -185,7 +185,7 @@ modparam("app_java", "class_name", "Kamailio")
 
    TBD.
 
-   Default value is “child_init”.
+   Default value is "child_init".
 
    Example 1.2. Set child_init_method parameter
 ...
@@ -196,7 +196,7 @@ modparam("app_java", "child_init_method", "my_mod_init")
 
    Java options for Java Virtual Machine. For more info read java docs
 
-   Default value is “-Djava.compiler=NONE”.
+   Default value is "-Djava.compiler=NONE".
 
    Example 1.3. Set java_options parameter
 ...
@@ -230,10 +230,10 @@ modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni
 4.4. force_cmd_exec (int)
 
    This parameter forces execution a kamailio comnmand with java native
-   method “KamExec”. # Note: this is an untested yet feature, may cause
+   method "KamExec". # Note: this is an untested yet feature, may cause
    (but may not) a memory leaks if used from embedded languages.
 
-   Default value is “0 (off)”.
+   Default value is "0 (off)".
 
    Example 1.7. Set force_cmd_exec parameter
 ...
@@ -255,9 +255,9 @@ modparam("app_java", "force_cmd_exec", 1)
    5.5. java_s_staticmethod_exec(method, method_signature, [param1[,
           param2[, ...]]])
 
-5.1.  Common requirements
+5.1. Common requirements
 
-   Each function has a required parameter “method_signature”. For more
+   Each function has a required parameter "method_signature". For more
    info see Determine the signature of a method. Signature represents the
    variable type. The mapping between the Java type and C type is
                 Type     Chararacter
@@ -362,7 +362,7 @@ public int ExampleMethod(boolean flagSet, byte bFlag);
 5.3. java_staticmethod_exec(method, method_signature, [param1[, param2[,
 ...]]])
 
-   Executes a java static method method. Parameter method_signature is
+   Executes a Java static method method. Parameter method_signature is
    required.
      * Example 1.11. Signature: "V"
        Kamailio prototype
@@ -421,7 +421,7 @@ public static int ExampleMethod(boolean flagSet, byte bFlag);
 
 5.4. java_s_method_exec(method, method_signature, [param1[, param2[, ...]]])
 
-   Executes a java class synchronized method method. Parameter
+   Executes a Java class synchronized method method. Parameter
    method_signature is required.
 
    For more info see Synchronized Methods
diff --git a/modules/app_java/doc/app_java_admin.xml b/modules/app_java/doc/app_java_admin.xml
index 43f9fa1..a9e8f1a 100644
--- a/modules/app_java/doc/app_java_admin.xml
+++ b/modules/app_java/doc/app_java_admin.xml
@@ -19,8 +19,9 @@
     <section>
 		<title>Overview</title>
 		<para>
-			This module allows executing Java compiled classes from config file, exporting
-			functions to access the SIP message from Java using Java Native Interface (JNI).
+			This module allows execution of Java compiled classes from the &kamailio;
+			config file, exporting functions to access the SIP message from Java
+			using the Java Native Interface (JNI).
 		</para>
     </section>
 	<!-- end op section Overview -->
@@ -99,7 +100,7 @@
 		<title>Parameters</title>
 
 		<!-- class_name -->
-		<section>
+		<section id="app_java.p.class_name">
 			<title><varname>class_name</varname> (string)</title>
 		    <para>
 		    	The class name should have the same compiled file name.
@@ -121,7 +122,7 @@ modparam("app_java", "class_name", "&kamailio;")
 		</section>
 
 		<!-- child_init_method -->
-		<section>
+		<section id="app_java.p.child_init_method">
 			<title><varname>child_init_method</varname> (string)</title>
 			<para>
 				TBD.
@@ -142,7 +143,7 @@ modparam("app_java", "child_init_method", "my_mod_init")
 		</section>
 
 		<!-- java_options -->
-		<section>
+		<section id="app_java.p.java_option">
 			<title><varname>java_options</varname> (string)</title>
 			<para>
 				Java options for Java Virtual Machine.
@@ -197,7 +198,7 @@ modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni
 		</section>
 
 		<!-- force_cmd_exec -->
-		<section>
+		<section id="app_java.p.force_cmd_exec">
 			<title><varname>force_cmd_exec</varname> (int)</title>
 			<para>
 				This parameter forces execution a &kamailiobinary; comnmand with java native method <quote>KamExec</quote>.
@@ -282,7 +283,7 @@ modparam("app_java", "force_cmd_exec", 1)
     	<!-- End of section Common Requirements -->
   
     	<!-- Section java_method_exec -->
-    	<section>
+	<section id="app_java.f.java_method_exec">
     		<title>java_method_exec(method, method_signature, [param1[, param2[, ...]]])</title>
     		<para>Executes a java class method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
     		<itemizedlist>
@@ -363,9 +364,9 @@ public int ExampleMethod(boolean flagSet, byte bFlag);
     	<!-- end of section java_method_exec -->
 
     	<!-- Section java_staticmethod_method_exec -->
-    	<section>
+	<section id="app_java.f.java_staticmethod_exec">
     		<title>java_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</title>
-    		<para>Executes a java static method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
+    		<para>Executes a Java static method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
     		<itemizedlist>
     			<listitem>
     				<example>
@@ -444,9 +445,9 @@ public static int ExampleMethod(boolean flagSet, byte bFlag);
     	<!-- end of section java_staticmethod_exec -->
     	
     	<!-- Section java_s_method_exec -->
-    	<section>
+	<section id="app_java.f.java_s_method_exec">
     		<title>java_s_method_exec(method, method_signature, [param1[, param2[, ...]]])</title>
-    		<para>Executes a java class synchronized method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
+    		<para>Executes a Java class synchronized method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
     		<para>For more info see <ulink url="http://docs.oracle.com/javase/tutorial/essential/concurrency/syncmeth.html"><citetitle>Synchronized Methods</citetitle></ulink></para>
     		<itemizedlist>
     			<listitem>
@@ -526,7 +527,7 @@ public synchronized int ExampleMethod(boolean flagSet, byte bFlag);
     	<!-- end of section java_s_method_exec -->
     	
     	<!-- Section java_s_staticmethod_exec -->
-    	<section>
+	<section id="app_java.f.java_s_staticmethod_exec">
     		<title>java_s_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</title>
     		<para>Executes a java synchronized static method <emphasis>method</emphasis>. Parameter <emphasis>method_signature</emphasis> is required.</para>
     		<para>For more info see <ulink url="http://docs.oracle.com/javase/tutorial/essential/concurrency/syncmeth.html"><citetitle>Synchronized Methods</citetitle></ulink></para>

More information about the sr-dev mailing list