Skip to content

Commit

Permalink
app_java: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@miconda
miconda committed Nov 13, 2023
1 parent 0d6ee69 commit 9284827
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 47 deletions.
4 changes: 2 additions & 2 deletions src/modules/app_java/doc/app_java.xml
View file
Expand Up @@ -29,7 +29,7 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="app_java_admin.xml"/>

</book>
90 changes: 45 additions & 45 deletions src/modules/app_java/doc/app_java_admin.xml
View file
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding='utf-8'?>

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
Expand All @@ -12,9 +12,9 @@
<!-- Module User's Guide -->

<chapter>

<title>&adminguide;</title>

<!-- Section Overview -->
<section>
<title>Overview</title>
Expand All @@ -25,7 +25,7 @@
</para>
</section>
<!-- end op section Overview -->

<!-- Section Dependencies -->
<section>
<title>Dependencies</title>
Expand All @@ -44,15 +44,15 @@
</para>
</section>
<!-- End of section Modules -->

<!-- Section External Libraries or Applications -->
<section>
<title>External Libraries or Applications</title>
<para>
<!--
The following libraries or applications must be installed before running
&kamailio; with this module loaded:
-->
-->
<itemizedlist>
<para><emphasis>The following packages are runtime libraries, required to launch</emphasis></para>
<listitem override="disc"><para><emphasis>java-common</emphasis> Base of all Java packages.</para></listitem>
Expand Down Expand Up @@ -84,7 +84,7 @@
<!-- end of section External Libraries or Applications -->
</section>
<!-- end of section Dependencies -->

<!-- Section Java Runtime -->
<section>
<title>Java runtime</title>
Expand All @@ -94,7 +94,7 @@
</section>
</section>
<!-- end of section Java Runtime -->

<!-- Section Parameters -->
<section>
<title>Parameters</title>
Expand Down Expand Up @@ -167,7 +167,7 @@ modparam("app_java", "java_options", "-Djava.compiler=NONE")
<programlisting format="linespecific">
...
# Assumes "application java folder" is located at /opt/kamailio/java
modparam("app_java", "java_options", "-Djava.compiler=NONE
modparam("app_java", "java_options", "-Djava.compiler=NONE
-Djava.class.path=/path/to/kamailio/modules:/opt/kamailio/java:
/opt/kamailio/java/kamailio.jar")
...
Expand All @@ -178,7 +178,7 @@ modparam("app_java", "java_options", "-Djava.compiler=NONE
<programlisting format="linespecific">
...
# Assumes "application java folder" is located at /opt/kamailio/java
modparam("app_java", "java_options", "-verbose:gc,class,jni
modparam("app_java", "java_options", "-verbose:gc,class,jni
-Djava.compiler=NONE -Djava.class.path=/path/to/kamailio/modules:
/opt/kamailio/java:/opt/kamailio/java/kamailio.jar")
...
Expand All @@ -189,7 +189,7 @@ modparam("app_java", "java_options", "-verbose:gc,class,jni
<programlisting format="linespecific">
...
# Assumes "application java folder" is located at /opt/kamailio/java
modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni
modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni
-Djava.compiler=NONE -Djava.class.path=/path/to/kamailio/modules:
/opt/kamailio/java:/opt/kamailio/java/kamailio.jar")
...
Expand Down Expand Up @@ -220,11 +220,11 @@ modparam("app_java", "force_cmd_exec", 1)
</section>
</section>
<!-- End of section Parameters -->

<!-- Section Functions -->
<section>
<title>Functions</title>

<!-- Section Common requirements -->
<section>
<title>
Expand All @@ -236,25 +236,25 @@ modparam("app_java", "force_cmd_exec", 1)
Signature represents the variable type. The mapping between the Java type and C type
is
<programlisting format="linespecific">
Type Chararacter
boolean Z
byte B
char C
double D
float F
int I
long J
object L
short S
void V
Note that to specify an object, the "L" is followed by the
Type Chararacter
boolean Z
byte B
char C
double D
float F
int I
long J
object L
short S
void V
Note that to specify an object, the "L" is followed by the
object's class name and ends with a semi-colon, ';' .
</programlisting>
</para>
<para> app_java supports the following signatures:
<programlisting format="linespecific">
Primitives: Z,B,C,D,F,I,J,L,S,V
Objects:
Objects:
Ljava/lang/Boolean;
Ljava/lang/Byte;
Ljava/lang/Character;
Expand All @@ -267,7 +267,7 @@ modparam("app_java", "force_cmd_exec", 1)
NULL parameter: V

Each parameter passed to function will be cast according to given signature.

Parameters are optional, omitting a parameter meant the passed value is NULL.
Parameters count should be exactly the same as signature count.
Note 1: Arrays representation (symbol '[') is not supported yet.
Expand All @@ -278,10 +278,10 @@ modparam("app_java", "force_cmd_exec", 1)
</programlisting>
</para>


</section>
<!-- End of section Common Requirements -->

<!-- Section java_method_exec -->
<section id="app_java.f.java_method_exec">
<title>java_method_exec(method, method_signature, [param1[, param2[, ...]]])</title>
Expand All @@ -308,7 +308,7 @@ public int ExampleMethod()
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "Ljava/lang/String;I"</title>
Expand Down Expand Up @@ -389,7 +389,7 @@ public static int ExampleMethod()
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "Ljava/lang/String;I"</title>
Expand All @@ -412,7 +412,7 @@ public static int ExampleMethod(String SipMessageBuffer, int SipMessageLength)
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "ZB"</title>
Expand All @@ -439,11 +439,11 @@ public static int ExampleMethod(boolean flagSet, byte bFlag);
</programlisting>
</example>
</listitem>

</itemizedlist>
</section>
<!-- end of section java_staticmethod_exec -->

<!-- Section java_s_method_exec -->
<section id="app_java.f.java_s_method_exec">
<title>java_s_method_exec(method, method_signature, [param1[, param2[, ...]]])</title>
Expand Down Expand Up @@ -471,7 +471,7 @@ public synchronized int ExampleMethod()
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "Ljava/lang/String;I"</title>
Expand All @@ -494,7 +494,7 @@ public synchronized int ExampleMethod(String SipMessageBuffer, int SipMessageLen
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "ZB"</title>
Expand All @@ -521,11 +521,11 @@ public synchronized int ExampleMethod(boolean flagSet, byte bFlag);
</programlisting>
</example>
</listitem>

</itemizedlist>
</section>
<!-- end of section java_s_method_exec -->

<!-- Section java_s_staticmethod_exec -->
<section id="app_java.f.java_s_staticmethod_exec">
<title>java_s_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</title>
Expand Down Expand Up @@ -553,7 +553,7 @@ public static synchronized int ExampleMethod()
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "Ljava/lang/String;I"</title>
Expand All @@ -576,7 +576,7 @@ public static synchronized int ExampleMethod(String SipMessageBuffer, int SipMes
</programlisting>
</example>
</listitem>

<listitem>
<example>
<title>Signature: "ZB"</title>
Expand All @@ -603,19 +603,19 @@ public static synchronized int ExampleMethod(boolean flagSet, byte bFlag);
</programlisting>
</example>
</listitem>

</itemizedlist>
</section>
<!-- end of section java_s_method_exec -->

</section>
<!-- End of section Functions -->

<!-- Section Java API-->
<section>
<title>Java Module API</title>
<para></para>

<!-- Section Minimal program skeleton -->
<section>
<title>Minimal program skeleton</title>
Expand Down Expand Up @@ -653,9 +653,9 @@ public class Kamailio extends NativeMethods
</example>
</section>
<!-- End of section Minimal program skeleton -->

</section>
<!-- End of section Java API -->

</chapter>

0 comments on commit 9284827

Please sign in to comment.