[cp-patches] FYI: API doc updates for java.awt.image.DataBufferXXX classes

[David Gilbert]

I committed this patch to update the API doc descriptions for the
DataBuffer classes.  I also removed a few unnecessary casts that Eclipse
highlighted.

2005-07-01  David Gilbert  <address@hidden>

        * java/awt/image/DataBuffer.java: fixed API doc typos;
        * java/awt/image/DataBufferByte.java: added description to API docs;
        * java/awt/image/DataBufferDouble.java: added description to API docs,
        (setElem(int, int)): removed unnecessary cast;
        (setElem(int, int, int)): likewise.
        * java/awt/image/DataBufferFloat.java: added description to API docs;
        (setElem(int, int)): removed unnecessary cast;
        (setElem(int, int, int)): likewise.
        * java/awt/image/DataBufferInt.java: added description to API docs;
        * java/awt/image/DataBufferShort.java: likewise;
        * java/awt/image/DataBufferUShort.java: likewise.

Regards,

Dave Gilbert

Index: java/awt/image/DataBuffer.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBuffer.java,v
retrieving revision 1.4
diff -u -r1.4 DataBuffer.java
--- java/awt/image/DataBuffer.java      16 Feb 2005 10:39:27 -0000      1.4
+++ java/awt/image/DataBuffer.java      1 Jul 2005 10:22:22 -0000
@@ -1,4 +1,4 @@
-/* Copyright (C) 2000, 2002  Free Software Foundation
+/* Copyright (C) 2000, 2002, 2005  Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -46,43 +46,43 @@
 public abstract class DataBuffer
 {
   /**
-   * A constant representng a data type that uses <code>byte</code> primitives
+   * A constant representing a data type that uses <code>byte</code> primitives
    * as the storage unit.
    */
   public static final int TYPE_BYTE      =  0;
 
   /**
-   * A constant representng a data type that uses <code>short</code> 
+   * A constant representing a data type that uses <code>short</code> 
    * primitives as the storage unit.
    */
   public static final int TYPE_USHORT    =  1;
 
   /**
-   * A constant representng a data type that uses <code>short</code> 
+   * A constant representing a data type that uses <code>short</code> 
    * primitives as the storage unit.
    */
   public static final int TYPE_SHORT     =  2;
 
   /**
-   * A constant representng a data type that uses <code>int</code> 
+   * A constant representing a data type that uses <code>int</code> 
    * primitives as the storage unit.
    */
   public static final int TYPE_INT       =  3;
   
   /**
-   * A constant representng a data type that uses <code>float</code> 
+   * A constant representing a data type that uses <code>float</code> 
    * primitives as the storage unit.
    */
   public static final int TYPE_FLOAT     =  4;
 
   /**
-   * A constant representng a data type that uses <code>double</code> 
+   * A constant representing a data type that uses <code>double</code> 
    * primitives as the storage unit.
    */
   public static final int TYPE_DOUBLE    =  5;
 
   /**
-   * A constant representng an undefined data type.
+   * A constant representing an undefined data type.
    */
   public static final int TYPE_UNDEFINED = 32;
   
Index: java/awt/image/DataBufferByte.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferByte.java,v
retrieving revision 1.6
diff -u -r1.6 DataBufferByte.java
--- java/awt/image/DataBufferByte.java  16 Feb 2005 10:39:27 -0000      1.6
+++ java/awt/image/DataBufferByte.java  1 Jul 2005 10:22:22 -0000
@@ -47,6 +47,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>byte</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @author Rolf W. Rasmussen (address@hidden)
  */
 public final class DataBufferByte extends DataBuffer
Index: java/awt/image/DataBufferDouble.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferDouble.java,v
retrieving revision 1.4
diff -u -r1.4 DataBufferDouble.java
--- java/awt/image/DataBufferDouble.java        16 Feb 2005 10:39:27 -0000      
1.4
+++ java/awt/image/DataBufferDouble.java        1 Jul 2005 10:22:22 -0000
@@ -1,4 +1,4 @@
-/* Copyright (C) 2004  Free Software Foundation
+/* Copyright (C) 2004, 2005  Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -47,6 +47,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>double</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @since 1.4
  *
  * @author Rolf W. Rasmussen (address@hidden)
@@ -226,7 +229,7 @@
    */
   public void setElem(int i, int val)
   {
-    data[i+offset] = (double) val;
+    data[i+offset] = val;
   }
 
   /**
@@ -240,7 +243,7 @@
    */
   public void setElem(int bank, int i, int val)
   {
-    bankData[bank][i+offsets[bank]] = (double) val;
+    bankData[bank][i+offsets[bank]] = val;
   }
 
   public float getElemFloat(int i)
Index: java/awt/image/DataBufferFloat.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferFloat.java,v
retrieving revision 1.4
diff -u -r1.4 DataBufferFloat.java
--- java/awt/image/DataBufferFloat.java 16 Feb 2005 10:39:27 -0000      1.4
+++ java/awt/image/DataBufferFloat.java 1 Jul 2005 10:22:22 -0000
@@ -1,4 +1,4 @@
-/* Copyright (C) 2004  Free Software Foundation
+/* Copyright (C) 2004, 2005  Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -47,6 +47,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>float</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @author Rolf W. Rasmussen (address@hidden)
  * @author Sascha Brawer (address@hidden)
  */
@@ -224,7 +227,7 @@
    */
   public void setElem(int i, int val)
   {
-    data[i+offset] = (float) val;
+    data[i+offset] = val;
   }
 
   /**
@@ -238,7 +241,7 @@
    */
   public void setElem(int bank, int i, int val)
   {
-    bankData[bank][i+offsets[bank]] = (float) val;
+    bankData[bank][i+offsets[bank]] = val;
   }
 
   public float getElemFloat(int i)
Index: java/awt/image/DataBufferInt.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferInt.java,v
retrieving revision 1.6
diff -u -r1.6 DataBufferInt.java
--- java/awt/image/DataBufferInt.java   16 Feb 2005 10:39:27 -0000      1.6
+++ java/awt/image/DataBufferInt.java   1 Jul 2005 10:22:22 -0000
@@ -1,4 +1,4 @@
-/* Copyright (C) 2000, 2002  Free Software Foundation
+/* Copyright (C) 2000, 2002, 2005  Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -47,6 +47,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>int</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @author Rolf W. Rasmussen (address@hidden)
  */
 public final class DataBufferInt extends DataBuffer
Index: java/awt/image/DataBufferShort.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferShort.java,v
retrieving revision 1.5
diff -u -r1.5 DataBufferShort.java
--- java/awt/image/DataBufferShort.java 16 Feb 2005 10:39:27 -0000      1.5
+++ java/awt/image/DataBufferShort.java 1 Jul 2005 10:22:22 -0000
@@ -1,5 +1,5 @@
 /* DataBufferShort.java --
-   Copyright (C) 2004  Free Software Foundation
+   Copyright (C) 2004, 2005  Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -48,6 +48,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>short</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @author Rolf W. Rasmussen (address@hidden)
  */
 public final class DataBufferShort extends DataBuffer
Index: java/awt/image/DataBufferUShort.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/image/DataBufferUShort.java,v
retrieving revision 1.7
diff -u -r1.7 DataBufferUShort.java
--- java/awt/image/DataBufferUShort.java        16 Feb 2005 10:39:27 -0000      
1.7
+++ java/awt/image/DataBufferUShort.java        1 Jul 2005 10:22:22 -0000
@@ -1,5 +1,5 @@
 /* DataBufferUShort.java --
-   Copyright (C) 2000, 2002, 2004  Free Software Foundation
+   Copyright (C) 2000, 2002, 2004, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -48,6 +48,9 @@
    code is a maintenance nightmare.  */
 
 /**
+ * A address@hidden DataBuffer} that uses an array of <code>short</code> 
primitives
+ * to represent each of its banks. 
+ * 
  * @author Rolf W. Rasmussen (address@hidden)
  */
 public final class DataBufferUShort extends DataBuffer