With examples and documentation as javadoc comments 27/1927/2
Sylvestre Ledru [Tue, 14 Sep 2010 16:03:36 +0000 (18:03 +0200)]
Change-Id: Ia55da1d0d5561b15ec1e53bc7060991536c58873

scilab/modules/types/src/java/org/scilab/modules/types/ScilabBoolean.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabDouble.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabInteger.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabList.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabMList.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabString.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabTList.java

index f85658a..7e10a7e 100644 (file)
@@ -16,7 +16,14 @@ package org.scilab.modules.types;
 import java.util.Arrays;
 
 /**
- * This class provides a wrapping on the Scilab boolean datatype
+ * This class provides a representation on the Scilab boolean datatype<br />
+ * <br>
+ * Example:<br />
+ * <code>
+ * boolean [][]a={{true,false,true}, {true,true,true}};<br />
+ * ScilabBoolean aMatrix = new ScilabBoolean(a);
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabBoolean implements ScilabType {
 
index acf162d..af47a15 100644 (file)
@@ -16,8 +16,23 @@ package org.scilab.modules.types;
 import java.util.Arrays;
 
 /**
- * This class provides a wrapping on the Scilab Double datatype<br />
+ * This class provides a representation on the Scilab Double datatype<br />
  * Note that double is the default datatype in Scilab
+ * <br>
+ * Example (real):<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);<br />
+ * </code>
+ * <br>
+ * Example (complex):<br />
+ * <code>
+ * double [][]a={{21.2, 22.0, 42.0, 39.0},{23.2, 24.0, 44.0, 40.0}};<br />
+ * double [][]aImg={{210.2, 220.0, 420.0, 390.0},{230.2, 240.0, 440.0, 400.0}};<br />
+
+ * ScilabDouble aMatrix = new ScilabDouble(a, aImg);
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabDouble implements ScilabType {
 
index f5ece5e..fb1c80c 100644 (file)
@@ -15,7 +15,14 @@ package org.scilab.modules.types;
 import java.util.Arrays;
 
 /**
- * This class provides a wrapping on the Scilab Integer datatype
+ * This class provides a representation on the Scilab Integer datatype
+ * <br>
+ * Example:<br />
+ * <code>
+ * byte [][]a={{32,42,41}, {12,13,32}};<br />
+ * ScilabInteger aMatrix = new ScilabInteger(a, true); // true = unsigned 
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabInteger implements ScilabType {
 
index 8bf984d..09b1e94 100644 (file)
@@ -16,7 +16,15 @@ import java.util.ArrayList;
 import java.util.Collection;
 
 /**
- * This class provides a wrapping on the Scilab List datatype
+ * This class provides a representation on the Scilab List datatype
+ * <br>
+ * Example:<br />
+ * <code>
+ * ScilabList data = new ScilabList();<br />
+ * data.add(new ScilabString("hello"));<br />
+ * data.add(new ScilabDouble(2));<br />
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
        
index 040c348..736ac27 100644 (file)
@@ -16,7 +16,15 @@ import java.util.ArrayList;
 import java.util.Collection;
 
 /**
- * This class provides a wrapping on the Scilab Mlist datatype
+ * This class provides a representation on the Scilab MList datatype
+ * <br>
+ * Example:<br />
+ * <code>
+ * ScilabMList data = new ScilabMList();<br />
+ * data.add(new ScilabString("hello"));<br />
+ * data.add(new ScilabDouble(2));<br />
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
    
index 1e3212f..dbf4c98 100644 (file)
@@ -15,7 +15,14 @@ package org.scilab.modules.types;
 import java.util.Arrays;
 
 /**
- * This class provides a wrapping on the Scilab String datatype
+ * This class provides a representation on the Scilab String datatype
+ * <br>
+ * Example:<br />
+ * <code>
+ * String [][]a={{"This","is","my","string"},{"and","I want to", "compare"," them"}};<br />
+ * ScilabString aMatrix = new ScilabString(a);
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabString implements ScilabType {
 
index d7ff5d1..ff3359d 100644 (file)
@@ -16,7 +16,15 @@ import java.util.ArrayList;
 import java.util.Collection;
 
 /**
- * This class provides a wrapping on the Scilab TList datatype
+ * This class provides a representation on the Scilab TList datatype
+ * <br>
+ * Example:<br />
+ * <code>
+ * ScilabTList data = new ScilabTList();<br />
+ * data.add(new ScilabString("hello"));<br />
+ * data.add(new ScilabDouble(2));<br />
+ * </code>
+ * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {