Update of the documentation 56/11956/1
Sylvestre Ledru [Fri, 5 Jul 2013 14:18:30 +0000 (16:18 +0200)]
Change-Id: Ic398c683aa7d4e753c736507f1b1213e52fd3aa0

13 files changed:
scilab/modules/external_objects_java/help/en_US/jallowClassReloading.xml
scilab/modules/external_objects_java/help/en_US/jautoUnwrap.xml
scilab/modules/external_objects_java/help/en_US/jcast.xml
scilab/modules/external_objects_java/help/en_US/jconvMatrixMethod.xml
scilab/modules/external_objects_java/help/en_US/jexists.xml
scilab/modules/external_objects_java/help/en_US/jgetclassname.xml
scilab/modules/external_objects_java/help/en_US/jgetfield.xml
scilab/modules/external_objects_java/help/en_US/jimport.xml
scilab/modules/external_objects_java/help/en_US/jnewInstance.xml
scilab/modules/external_objects_java/help/en_US/jsetfield.xml
scilab/modules/external_objects_java/help/en_US/junwrap.xml
scilab/modules/external_objects_java/help/en_US/junwraprem.xml
scilab/modules/external_objects_java/help/en_US/jvoid.xml

index 396031b..6a1bf42 100644 (file)
@@ -55,6 +55,7 @@
         <programlisting role="example"><![CDATA[
                jallowClassReloading(%t);
                jallowClassReloading()
+               jallowClassReloading(%f);
       ]]></programlisting>
     </refsection>
     <refsection role="see also">
index b45f6bd..2840d4c 100644 (file)
             If autoUnwrap is true, all the values returned by a method invocation are unwrapped if it is possible.
         </para>
         <para>
-            By default, autoUnwrap is false.
+          This strongly simplifies the usage of the Java / Scilab conversions.
+        </para>
+        <para>
+            By default, autoUnwrap is true.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
+               jautoUnwrap(%f);
                jautoUnwrap()
                jautoUnwrap(%t);
       ]]></programlisting>
index ac1c435..029ab36 100644 (file)
@@ -15,7 +15,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="jcast">
     <refnamediv>
         <refname>jcast</refname>
-        <refpurpose>Cast a Java object into an other one.</refpurpose>
+        <refpurpose>Cast a Java object into another one.</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -43,7 +43,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            Gives the possisbility to cast an object into another one with the given class if it is possible.
+            Cast an object into another one with the given class if it is possible.
         </para>
     </refsection>
     <refsection>
index bf537e9..cbea4f4 100644 (file)
@@ -53,7 +53,8 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-               jconvMatrixMethod();
+               jconvMatrixMethod()
+               jconvMatrixMethod("cr")
       ]]></programlisting>
     </refsection>
 </refentry>
index 5f6cb1d..3ab9d22 100644 (file)
@@ -53,7 +53,7 @@
               d = Double.new("1.23456");
               jexists(d)
               jremove d;
-              jexists(d)
+              jexists(d) // Will fail
       ]]></programlisting>
     </refsection>
     <refsection role="see also">
index cc8c97d..bad1a95 100644 (file)
@@ -15,7 +15,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="jgetclassname">
     <refnamediv>
         <refname>jgetclassname</refname>
-        <refpurpose>Give the class name of the given object</refpurpose>
+        <refpurpose>Return the class name of the given object</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
index b4f1a0f..1708592 100644 (file)
@@ -68,7 +68,7 @@
                v = jgetfield(t, "field")
 
                // or more easier
-               junwraprem(t.field)
+               t.field
 
                jremove c t v;
       ]]></programlisting>
index 9865a33..cd0545b 100644 (file)
             When <literal>jimport("java.lang.String")</literal>, a mlist named String is created on the Scilab stack. The created mlist has a type equals to _JClass and can be used to instantiate new objects in using something like <literal>str = String.new("A Scilab String");</literal>. It is possible to call the static methods (if exist) of the class
         </para>
         <programlisting role="example"><![CDATA[
+               jautoUnwrap(%f);
                jimport java.lang.System;
                jimport java.util.Date;
                System.err.println("A message print in the Scilab console");
-               l = System.currentTimeMillis();
+               l = System.currentTimeMillis(); //Working with the object is necessary
                d = Date.new(l)
                jremove(l,d);
+               jautoUnwrap(%t);
       ]]></programlisting>
         <para>
             To avoid confusion with already existing Scilab variables, the second argument isAClassReturned can be used
index d324e18..68d17c8 100644 (file)
@@ -55,6 +55,7 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
+               jautoUnwrap(%f)
                jimport java.util.Date;
                jimport java.lang.System;
 
@@ -64,6 +65,7 @@
                d = s.toString()
 
                jremove Date System t s str;
+               jautoUnwrap(%t)
       ]]></programlisting>
     </refsection>
     <refsection role="see also">
index f2bdb78..cb5578a 100644 (file)
                                      "}";
                                      "}";]);
                t = c.new(128);
-               junwrap(t.field)
+               t.field
                jsetfield(t, "field", 256);
-               junwrap(t.field)
+               t.field
 
                // But it is easier to use...
                t.field = 512;
-               junwrap(t.field)
+               t.field
                jremove c t;
       ]]></programlisting>
         <programlisting role="example"><![CDATA[
index 5f9d510..88ce263 100644 (file)
@@ -54,9 +54,9 @@
                s = String.new("Hello JIMS !!");
                s1 = s.toUpperCase();
                s2 = s.toLowerCase()
-               [S1 S2] = junwrap(s1, s2)
-               typeof(S1), typeof(S2)
-
+               typeof(s1), typeof(s2)
+               typeof(jwrap(s1))
+               typeof(jwrap(s2))
                jremove s s1 s2
       ]]></programlisting>
     </refsection>
index b328eed..75e013b 100644 (file)
@@ -49,6 +49,7 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
+               jautoUnwrap(%f);
                jimport java.lang.String;
 
                s = String.new("Hello JIMS !!");
@@ -57,6 +58,7 @@
                [S1 S2] = junwraprem(s1, s2)
 
                jremove s
+               jautoUnwrap(%t);
       ]]></programlisting>
     </refsection>
     <refsection role="see also">
index 16217bf..ad7b751 100644 (file)
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-              jimport java.lang.String;
-              
-              s = String.new(jvoid);
+        jimport java.lang.String;
+
+        s = String.new(jvoid);
+        jgetclassname(s)
       ]]></programlisting>
     </refsection>
 </refentry>