Documentation improved (Javadoc) 29/1929/2
Sylvestre Ledru [Tue, 14 Sep 2010 16:25:40 +0000 (18:25 +0200)]
Change-Id: I9905cf9889c12bf781a86904ba55f9161cca3fe7

scilab/modules/javasci/src/java/org/scilab/modules/javasci/Call_Scilab.java
scilab/modules/javasci/src/java/org/scilab/modules/javasci/Call_ScilabJNI.java
scilab/modules/javasci/src/java/org/scilab/modules/javasci/package.html [new file with mode: 0644]
scilab/modules/javasci/src/jni/call_scilab.i
scilab/modules/types/src/java/org/scilab/modules/types/package.html [new file with mode: 0644]

index 0b1070e..6a03851 100644 (file)
@@ -13,9 +13,10 @@ import org.scilab.modules.types.ScilabTypeEnum;
 import org.scilab.modules.types.ScilabIntegerTypeEnum;
 
  /**
-   * Connector for Javasci v2
-   * @author Sylvestre LEDRU
-   * @copyright DIGITEO
+   * Connector for Javasci v2.
+   * This class should <b>not</b> be used directly
+   * @see org.scilab.modules.javasci.Scilab
+   * @author DIGITEO - Sylvestre LEDRU
    */
 public class Call_Scilab {
 
index a09d3fd..0e73a5e 100644 (file)
@@ -12,9 +12,10 @@ package org.scilab.modules.javasci;
 /* It is generated code. Disable checkstyle */
 //CHECKSTYLE:OFF
  /**
-   * Connector for Javasci v2
-   * @author Sylvestre LEDRU
-   * @copyright DIGITEO
+   * Connector for Javasci v2.
+   * This class should <b>not</b> be used directly
+   * @see org.scilab.modules.javasci.Scilab
+   * @author DIGITEO - Sylvestre LEDRU
    */
 class Call_ScilabJNI {
 
diff --git a/scilab/modules/javasci/src/java/org/scilab/modules/javasci/package.html b/scilab/modules/javasci/src/java/org/scilab/modules/javasci/package.html
new file mode 100644 (file)
index 0000000..d65eeb7
--- /dev/null
@@ -0,0 +1,18 @@
+<html>
+<body>
+
+This package provides a way to use and call Scilab engine from a Java 
+application or library.<br />
+<br />
+Example:<br />
+<code>
+Scilab sci = new Scilab();<br />
+sci.open();<br />
+sci.exec("b = matrix(1:100,10,10)");<br />
+ScilabType b = sci.get("b");<br />
+b.getHeight(); // 10 <br />
+b.getWidth(); // 10<br />
+ScilabDouble b2 = (ScilabDouble)sci.get("b");<br />
+b2.equals(b); // true<br />
+</body>
+</html>
\ No newline at end of file
index 8d8e67c..62d228c 100644 (file)
 /* It is generated code. Disable checkstyle */
 //CHECKSTYLE:OFF
  /**
-   * Connector for Javasci v2
-   * @author Sylvestre LEDRU
-   * @copyright DIGITEO
+   * Connector for Javasci v2.
+   * This class should <b>not</b> be used directly
+   * @see org.scilab.modules.javasci.Scilab
+   * @author DIGITEO - Sylvestre LEDRU
    */
 class%}
 
@@ -81,13 +82,14 @@ class%}
 
 /* JavaDoc for Call_Scilab class */
 %pragma(java) moduleclassmodifiers="
-import org.scilab.modules.types.scilabTypes.ScilabTypeEnum;
-import org.scilab.modules.types.scilabTypes.ScilabIntegerTypeEnum;
+import org.scilab.modules.types.ScilabTypeEnum;
+import org.scilab.modules.types.ScilabIntegerTypeEnum;
 
  /**
-   * Connector for Javasci v2
-   * @author Sylvestre LEDRU
-   * @copyright DIGITEO
+   * Connector for Javasci v2.
+   * This class should <b>not</b> be used directly
+   * @see org.scilab.modules.javasci.Scilab
+   * @author DIGITEO - Sylvestre LEDRU
    */
 public class";
 
diff --git a/scilab/modules/types/src/java/org/scilab/modules/types/package.html b/scilab/modules/types/src/java/org/scilab/modules/types/package.html
new file mode 100644 (file)
index 0000000..0c64904
--- /dev/null
@@ -0,0 +1,12 @@
+<html>
+<body>
+This packages provides a representation of most of the Scilab datatypes.<br />
+<br />
+
+Example:<br />
+<code>
+double [][]a={{21.2, 22.0, 42.0, 39.0},{23.2, 24.0, 44.0, 40.0}};<br />
+ScilabDouble aMatrix = new ScilabDouble(a);
+</code>
+</body>
+</html>