[Jython-checkins] CVS: jython/org/python/core PyFile.java,2.15,2.16 PyFinalizableInstance.java,2.2,2.3 PyFloat.java,2.7,2.8 PyFrame.java,2.5,2.6 PyFunction.java,2.8,2.9 PyFunctionTable.java,2.0,2.1 PyInstance.java,2.19,2.20 PyInteger.java,2.9,2.10 PyJavaInnerClass.java,2.7,2.8 PyJavaInstance.java,2.4,2.5 PyJavaPackage.java,2.9,2.10

[Finn B. <bc...@us...>]

Update of /cvsroot/jython/jython/org/python/core
In directory usw-pr-cvs1:/tmp/cvs-serv1253

Modified Files:
	PyFile.java PyFinalizableInstance.java PyFloat.java 
	PyFrame.java PyFunction.java PyFunctionTable.java 
	PyInstance.java PyInteger.java PyJavaInnerClass.java 
	PyJavaInstance.java PyJavaPackage.java 
Log Message:
Added javadoc comments.



Index: PyFile.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFile.java,v
retrieving revision 2.15
retrieving revision 2.16
diff -C2 -r2.15 -r2.16
*** PyFile.java	2001/02/02 09:28:36	2.15
--- PyFile.java	2001/02/25 16:47:44	2.16
***************
*** 12,15 ****
--- 12,19 ----
  // - name, mode, closed should be read-only
  
+ /**
+  * A python file wrapper around a java stream, reader/writer or file. 
+  */
+ 
  public class PyFile extends PyObject
  {

Index: PyFinalizableInstance.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFinalizableInstance.java,v
retrieving revision 2.2
retrieving revision 2.3
diff -C2 -r2.2 -r2.3
*** PyFinalizableInstance.java	2001/02/01 13:48:26	2.2
--- PyFinalizableInstance.java	2001/02/25 16:47:44	2.3
***************
*** 6,9 ****
--- 6,17 ----
  package org.python.core;
  
+ 
+ /**
+  * A python class instance with __del__ defined.
+  * <p>
+  * This is a special class due to performance. Defining
+  * finalize() on a class, makes the class a lot slower.
+  */
+ 
  public class PyFinalizableInstance extends PyInstance
  {

Index: PyFloat.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFloat.java,v
retrieving revision 2.7
retrieving revision 2.8
diff -C2 -r2.7 -r2.8
*** PyFloat.java	2001/02/07 09:23:52	2.7
--- PyFloat.java	2001/02/25 16:47:44	2.8
***************
*** 4,7 ****
--- 4,12 ----
  import java.io.Serializable;
  
+ 
+ /**
+  * A builtin python float.
+  */
+ 
  public class PyFloat extends PyObject
  {

Index: PyFrame.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFrame.java,v
retrieving revision 2.5
retrieving revision 2.6
diff -C2 -r2.5 -r2.6
*** PyFrame.java	2001/02/01 16:41:10	2.5
--- PyFrame.java	2001/02/25 16:47:44	2.6
***************
*** 2,5 ****
--- 2,10 ----
  package org.python.core;
  
+ 
+ /**
+  * A python frame object.
+  */
+ 
  public class PyFrame extends PyObject
  {

Index: PyFunction.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFunction.java,v
retrieving revision 2.8
retrieving revision 2.9
diff -C2 -r2.8 -r2.9
*** PyFunction.java	2001/02/02 13:06:36	2.8
--- PyFunction.java	2001/02/25 16:47:44	2.9
***************
*** 2,5 ****
--- 2,9 ----
  package org.python.core;
  
+ /**
+  * A python function.
+  */
+ 
  public class PyFunction extends PyObject
  {

Index: PyFunctionTable.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyFunctionTable.java,v
retrieving revision 2.0
retrieving revision 2.1
diff -C2 -r2.0 -r2.1
*** PyFunctionTable.java	1999/04/14 15:33:04	2.0
--- PyFunctionTable.java	2001/02/25 16:47:44	2.1
***************
*** 2,5 ****
--- 2,13 ----
  package org.python.core;
  
+ /**
+  * An entry point for class that implements several function calls.
+  * <P>
+  * Used together with the PyTableCode class.
+  *
+  * @see PyTableCode
+  */
+ 
  public abstract class PyFunctionTable {
      abstract public PyObject call_function(int index, PyFrame frame);

Index: PyInstance.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyInstance.java,v
retrieving revision 2.19
retrieving revision 2.20
diff -C2 -r2.19 -r2.20
*** PyInstance.java	2001/02/14 22:21:58	2.19
--- PyInstance.java	2001/02/25 16:47:44	2.20
***************
*** 4,7 ****
--- 4,11 ----
  import java.io.Serializable;
  
+ /**
+  * A python class instance.
+  */
+ 
  public class PyInstance extends PyObject
  {

Index: PyInteger.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyInteger.java,v
retrieving revision 2.9
retrieving revision 2.10
diff -C2 -r2.9 -r2.10
*** PyInteger.java	2001/02/07 09:23:52	2.9
--- PyInteger.java	2001/02/25 16:47:44	2.10
***************
*** 4,7 ****
--- 4,11 ----
  import java.io.Serializable;
  
+ /**
+  * A builtin python int.
+  */
+ 
  public class PyInteger extends PyObject
  {

Index: PyJavaInnerClass.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyJavaInnerClass.java,v
retrieving revision 2.7
retrieving revision 2.8
diff -C2 -r2.7 -r2.8
*** PyJavaInnerClass.java	2000/12/16 13:37:14	2.7
--- PyJavaInnerClass.java	2001/02/25 16:47:44	2.8
***************
*** 2,5 ****
--- 2,10 ----
  package org.python.core;
  
+ 
+ /**
+  * A wrapper around a java inner class.
+  */
+ 
  public class PyJavaInnerClass extends PyJavaClass
  {

Index: PyJavaInstance.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyJavaInstance.java,v
retrieving revision 2.4
retrieving revision 2.5
diff -C2 -r2.4 -r2.5
*** PyJavaInstance.java	2001/02/02 09:28:37	2.4
--- PyJavaInstance.java	2001/02/25 16:47:44	2.5
***************
*** 3,6 ****
--- 3,10 ----
  import java.lang.reflect.Modifier;
  
+ /**
+  * A wrapper around a java instance.
+  */
+ 
  public class PyJavaInstance
      extends PyInstance

Index: PyJavaPackage.java
===================================================================
RCS file: /cvsroot/jython/jython/org/python/core/PyJavaPackage.java,v
retrieving revision 2.9
retrieving revision 2.10
diff -C2 -r2.9 -r2.10
*** PyJavaPackage.java	2001/02/02 09:28:37	2.9
--- PyJavaPackage.java	2001/02/25 16:47:44	2.10
***************
*** 7,10 ****
--- 7,14 ----
  import java.io.File;
  
+ /**
+  * A representation of java package.
+  */
+ 
  public class PyJavaPackage extends PyObject {
      public String __name__;