Re: [cp-patches] [patch] document BufferCapabilities

[Mark Wielaard]

Hi,

On Wed, 2005-05-04 at 18:17 -0400, Thomas Fitzsimmons wrote:
> 2005-05-04  Thomas Fitzsimmons  <address@hidden>
> 
>       * java/awt/BufferCapabilities.java: Document.

This broke the GNU Classpath build:

   /**
    * Creates a buffer capabilities object.
    *
-   * @exception IllegalArgumentException If frontCaps or backCaps are null.
+   * @param frontCaps front buffer capabilities descriptor
+   * @param backCaps back buffer capabilities descriptor
+   * @param flipContents the results of a flip operation or null if
+   * flipping is not supported
+   *
+   * @exception IllegalArgumentException if frontCaps or backCaps is
+   * null
    */
-  public BufferCapabilities(ImageCapabilities front, ImageCapabilities back,
-                            FlipContents flip)
+  public BufferCapabilities(ImageCapabilities frontCaps,
+                           ImageCapabilities backCaps,
+                            FlipContents flipContents)

But now the arguments and the code don't match so we get errors like:

../java/awt/BufferCapabilities.java: In class `java.awt.BufferCapabilities':
../java/awt/BufferCapabilities.java: In constructor 
`(java.awt.ImageCapabilities,java.awt.ImageCapabilities,java.awt.BufferCapabilities$FlipContents)':
../java/awt/BufferCapabilities.java:147: error: variable 'front' may not have 
been initialized.
       if (front ==  null || back == null)
          ^
../java/awt/BufferCapabilities.java:147: error: variable 'back' may not have 
been initialized.
       if (front ==  null || back == null)
          ^
../java/awt/BufferCapabilities.java:151: error: variable 'flip' may not have 
been initialized.
       this.flip = flip;
   ^
3 errors

Obvious fix checked into GNU Classpath CVS:

2005-05-04  Mark Wielaard  <address@hidden>

        * java/awt/BufferCapabilities.java (BufferCapabilities): Make
        documentation of arguments match code.

Cheers,

Mark

Index: java/awt/BufferCapabilities.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/BufferCapabilities.java,v
retrieving revision 1.4
diff -u -r1.4 BufferCapabilities.java
--- java/awt/BufferCapabilities.java    4 May 2005 22:17:01 -0000       1.4
+++ java/awt/BufferCapabilities.java    5 May 2005 08:27:07 -0000
@@ -132,17 +132,17 @@
   /**
    * Creates a buffer capabilities object.
    *
-   * @param frontCaps front buffer capabilities descriptor
-   * @param backCaps back buffer capabilities descriptor
-   * @param flipContents the results of a flip operation or null if
+   * @param front front buffer capabilities descriptor
+   * @param back back buffer capabilities descriptor
+   * @param flip the results of a flip operation or null if
    * flipping is not supported
    *
-   * @exception IllegalArgumentException if frontCaps or backCaps is
+   * @exception IllegalArgumentException if front or back is
    * null
    */
-  public BufferCapabilities(ImageCapabilities frontCaps,
-                           ImageCapabilities backCaps,
-                            FlipContents flipContents)
+  public BufferCapabilities(ImageCapabilities front,
+                           ImageCapabilities back,
+                            FlipContents flip)
   {
     if (front ==  null || back == null)
       throw new IllegalArgumentException();

signature.asc
Description: This is a digitally signed message part