From 7d110ed90281613929d31c54fd71aa810b0aa9c0 Mon Sep 17 00:00:00 2001 From: prr Date: Tue, 6 Aug 2013 17:12:37 -0700 Subject: [PATCH] 8022447: Fix doclint warnings in java.awt.image Reviewed-by: darcy --- .../classes/java/awt/image/BufferStrategy.java | 4 ++-- .../classes/java/awt/image/BufferedImage.java | 16 ++++++++-------- .../classes/java/awt/image/ByteLookupTable.java | 2 +- src/share/classes/java/awt/image/ColorModel.java | 6 +++--- .../classes/java/awt/image/DirectColorModel.java | 12 ++++++------ .../classes/java/awt/image/ImageProducer.java | 4 ++-- .../classes/java/awt/image/IndexColorModel.java | 1 + .../java/awt/image/MemoryImageSource.java | 8 ++++---- .../awt/image/MultiPixelPackedSampleModel.java | 4 ++-- .../classes/java/awt/image/PixelGrabber.java | 14 +++++++------- .../classes/java/awt/image/RGBImageFilter.java | 4 ++-- .../classes/java/awt/image/ShortLookupTable.java | 4 ++-- .../awt/image/SinglePixelPackedSampleModel.java | 4 ++-- .../classes/java/awt/image/WritableRaster.java | 4 ++-- 14 files changed, 44 insertions(+), 43 deletions(-) diff --git a/src/share/classes/java/awt/image/BufferStrategy.java b/src/share/classes/java/awt/image/BufferStrategy.java index 82ad5e07d..de7877330 100644 --- a/src/share/classes/java/awt/image/BufferStrategy.java +++ b/src/share/classes/java/awt/image/BufferStrategy.java @@ -55,7 +55,7 @@ import java.awt.Image; * Alternatively, the contents of the back buffer can be copied, or * blitted forward in a chain instead of moving the video pointer. *

- * 

+ * 
{@code
  * Double buffering:
  *
  *                    ***********         ***********
@@ -72,7 +72,7 @@ import java.awt.Image;
  *          *         * <------ *         * <----- *         *
  *          ***********         ***********        ***********
  *
- * 

+ * }
*

* Here is an example of how buffer strategies can be created and used: * 


diff --git a/src/share/classes/java/awt/image/BufferedImage.java b/src/share/classes/java/awt/image/BufferedImage.java
index d510dcc1b..b4222b1e7 100644
--- a/src/share/classes/java/awt/image/BufferedImage.java
+++ b/src/share/classes/java/awt/image/BufferedImage.java
@@ -602,12 +602,12 @@ public class BufferedImage extends java.awt.Image
      *                  the raster has been premultiplied with alpha.
      * @param properties Hashtable of
      *                  String/Object pairs.
-     * @exception RasterFormatException if the number and
+     * @exception RasterFormatException if the number and
      * types of bands in the SampleModel of the
      * Raster do not match the number and types required by
      * the ColorModel to represent its color and alpha
      * components.
-     * @exception IllegalArgumentException if
+     * @exception IllegalArgumentException if
      *          raster is incompatible with cm
      * @see ColorModel
      * @see Raster
@@ -927,7 +927,7 @@ public class BufferedImage extends java.awt.Image
      * each color component in the returned data when
      * using this method.  With a specified coordinate (x, y) in the
      * image, the ARGB pixel can be accessed in this way:
-     * 

+     * 

      *
      * 
      *    pixel   = rgbArray[offset + (y-startY)*scansize + (x-startX)]; 

@@ -1131,7 +1131,7 @@ public class BufferedImage extends java.awt.Image
      * @return an {@link Object} that is the property referred to by the
      *          specified name or null if the
      *          properties of this image are not yet known.
-     * @throws NullPointerException if the property name is null.
+     * @throws NullPointerException if the property name is null.
      * @see ImageObserver
      * @see java.awt.Image#UndefinedProperty
      */
@@ -1144,7 +1144,7 @@ public class BufferedImage extends java.awt.Image
      * @param name the property name
      * @return an Object that is the property referred to by
      *          the specified name.
-     * @throws NullPointerException if the property name is null.
+     * @throws NullPointerException if the property name is null.
      */
     public Object getProperty(String name) {
         if (name == null) {
@@ -1196,7 +1196,7 @@ public class BufferedImage extends java.awt.Image
      * @param h the height of the specified rectangular region
      * @return a BufferedImage that is the subimage of this
      *          BufferedImage.
-     * @exception RasterFormatException if the specified
+     * @exception RasterFormatException if the specified
      * area is not contained within this BufferedImage.
      */
     public BufferedImage getSubimage (int x, int y, int w, int h) {
@@ -1388,7 +1388,7 @@ public class BufferedImage extends java.awt.Image
      * @param tileY the y index of the requested tile in the tile array
      * @return a Raster that is the tile defined by the
      *          arguments tileX and tileY.
-     * @exception ArrayIndexOutOfBoundsException if both
+     * @exception ArrayIndexOutOfBoundsException if both
      *          tileX and tileY are not
      *          equal to 0
      */
@@ -1558,7 +1558,7 @@ public class BufferedImage extends java.awt.Image
      * @return true if the tile specified by the specified
      *          indices is checked out for writing; false
      *          otherwise.
-     * @exception ArrayIndexOutOfBoundsException if both
+     * @exception ArrayIndexOutOfBoundsException if both
      *          tileX and tileY are not equal
      *          to 0
      */
diff --git a/src/share/classes/java/awt/image/ByteLookupTable.java b/src/share/classes/java/awt/image/ByteLookupTable.java
index 6f7e67d74..35968d62a 100644
--- a/src/share/classes/java/awt/image/ByteLookupTable.java
+++ b/src/share/classes/java/awt/image/ByteLookupTable.java
@@ -171,7 +171,7 @@ public class ByteLookupTable extends LookupTable {
      * @exception ArrayIndexOutOfBoundsException if src is
      *            longer than dst or if for any element
      *            i of src,
-     *            (src[i]&0xff)-offset is either less than
+     *            {@code (src[i]&0xff)-offset} is either less than
      *            zero or greater than or equal to the length of the
      *            lookup table for any band.
      */
diff --git a/src/share/classes/java/awt/image/ColorModel.java b/src/share/classes/java/awt/image/ColorModel.java
index 5ce313e1b..73f5b49fc 100644
--- a/src/share/classes/java/awt/image/ColorModel.java
+++ b/src/share/classes/java/awt/image/ColorModel.java
@@ -692,12 +692,12 @@ public abstract class ColorModel implements Transparency{
      * DataBuffer.TYPE_INT.
      * @param inData an array of pixel values
      * @return the value of the green component of the specified pixel.
-     * @throws ClassCastException if inData
+     * @throws ClassCastException if inData
      *  is not a primitive array of type transferType
-     * @throws ArrayIndexOutOfBoundsException if
+     * @throws ArrayIndexOutOfBoundsException if
      *  inData is not large enough to hold a pixel value
      *  for this ColorModel
-     * @throws UnsupportedOperationException if this
+     * @throws UnsupportedOperationException if this
      *  tranferType is not supported by this
      *  ColorModel
      */
diff --git a/src/share/classes/java/awt/image/DirectColorModel.java b/src/share/classes/java/awt/image/DirectColorModel.java
index 751d780ba..2ddd85c1a 100644
--- a/src/share/classes/java/awt/image/DirectColorModel.java
+++ b/src/share/classes/java/awt/image/DirectColorModel.java
@@ -642,12 +642,12 @@ public class DirectColorModel extends PackedColorModel {
      * @param inData the specified pixel
      * @return the alpha component of the specified pixel, scaled from
      *         0 to 255.
-     * @exception ClassCastException if inData
+     * @exception ClassCastException if inData
      *  is not a primitive array of type transferType
-     * @exception ArrayIndexOutOfBoundsException if
+     * @exception ArrayIndexOutOfBoundsException if
      *  inData is not large enough to hold a pixel value
      *  for this ColorModel
-     * @exception UnsupportedOperationException if this
+     * @exception UnsupportedOperationException if this
      *  tranferType is not supported by this
      *  ColorModel
      */
@@ -1055,7 +1055,7 @@ public class DirectColorModel extends PackedColorModel {
      * begin retrieving the color and alpha components
      * @return an int pixel value in this
      * ColorModel corresponding to the specified components.
-     * @exception ArrayIndexOutOfBoundsException if
+     * @exception ArrayIndexOutOfBoundsException if
      *  the components array is not large enough to
      *  hold all of the color and alpha components starting at
      *  offset
@@ -1097,9 +1097,9 @@ public class DirectColorModel extends PackedColorModel {
      * and alpha components
      * @return an Object representing an array of color and
      * alpha components.
-     * @exception ClassCastException if obj
+     * @exception ClassCastException if obj
      *  is not a primitive array of type transferType
-     * @exception ArrayIndexOutOfBoundsException if
+     * @exception ArrayIndexOutOfBoundsException if
      *  obj is not large enough to hold a pixel value
      *  for this ColorModel or the components
      *  array is not large enough to hold all of the color and alpha
diff --git a/src/share/classes/java/awt/image/ImageProducer.java b/src/share/classes/java/awt/image/ImageProducer.java
index 768aad50d..a419f8bd6 100644
--- a/src/share/classes/java/awt/image/ImageProducer.java
+++ b/src/share/classes/java/awt/image/ImageProducer.java
@@ -100,11 +100,11 @@ public interface ImageProducer {
      * ImageProducer should respond by executing
      * the following minimum set of ImageConsumer
      * method calls:
-     * 
+     * 
{@code
      *  ic.setHints(TOPDOWNLEFTRIGHT | < otherhints >);
      *  ic.setPixels(...);      // As many times as needed
      *  ic.imageComplete();
-     * 

+     * }

      * @param ic the specified ImageConsumer
      * @see ImageConsumer#setHints
      */
diff --git a/src/share/classes/java/awt/image/IndexColorModel.java b/src/share/classes/java/awt/image/IndexColorModel.java
index fabe8d204..d26e3d381 100644
--- a/src/share/classes/java/awt/image/IndexColorModel.java
+++ b/src/share/classes/java/awt/image/IndexColorModel.java
@@ -98,6 +98,7 @@ import java.math.BigInteger;
  * Index values greater than or equal to the map size, but less than
  * 2n, are undefined and return 0 for all color and
  * alpha components.
+ * 
  * 

  * For those methods that use a primitive array pixel representation of
  * type transferType, the array length is always one.
diff --git a/src/share/classes/java/awt/image/MemoryImageSource.java b/src/share/classes/java/awt/image/MemoryImageSource.java
index b5fd99b47..90519ce26 100644
--- a/src/share/classes/java/awt/image/MemoryImageSource.java
+++ b/src/share/classes/java/awt/image/MemoryImageSource.java
@@ -37,7 +37,7 @@ import java.util.Enumeration;
  * uses an array to produce pixel values for an Image.  Here is an example
  * which calculates a 100x100 image representing a fade from black to blue
  * along the X axis and a fade from black to red along the Y axis:
- * 
+ * 
{@code
  *
  *      int w = 100;
  *      int h = 100;
@@ -52,12 +52,12 @@ import java.util.Enumeration;
  *      }
  *      Image img = createImage(new MemoryImageSource(w, h, pix, 0, w));
  *
- * 

+ * }

  * The MemoryImageSource is also capable of managing a memory image which
  * varies over time to allow animation or custom rendering.  Here is an
  * example showing how to set up the animation source and signal changes
  * in the data (adapted from the MemoryAnimationSourceDemo by Garth Dickie):
- * 
+ * 
{@code
  *
  *      int pixels[];
  *      MemoryImageSource source;
@@ -96,7 +96,7 @@ import java.util.Enumeration;
  *          }
  *      }
  *
- * 

+ * }

  *
  * @see ImageProducer
  *
diff --git a/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java b/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java
index 43d3a8080..8095dad2f 100644
--- a/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java
+++ b/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java
@@ -52,14 +52,14 @@ package java.awt.image;
  * x, y from DataBuffer data
  * and storing the pixel data in data elements of type
  * dataType:
- * 
+ * 
{@code
  *      int dataElementSize = DataBuffer.getDataTypeSize(dataType);
  *      int bitnum = dataBitOffset + x*pixelBitStride;
  *      int element = data.getElem(y*scanlineStride + bitnum/dataElementSize);
  *      int shift = dataElementSize - (bitnum & (dataElementSize-1))
  *                  - pixelBitStride;
  *      int pixel = (element >> shift) & ((1 << pixelBitStride) - 1);
- * 

+ * }

  */
 
 public class MultiPixelPackedSampleModel extends SampleModel
diff --git a/src/share/classes/java/awt/image/PixelGrabber.java b/src/share/classes/java/awt/image/PixelGrabber.java
index 85dde7875..2053ed71b 100644
--- a/src/share/classes/java/awt/image/PixelGrabber.java
+++ b/src/share/classes/java/awt/image/PixelGrabber.java
@@ -35,7 +35,7 @@ import java.awt.Image;
  * The PixelGrabber class implements an ImageConsumer which can be attached
  * to an Image or ImageProducer object to retrieve a subset of the pixels
  * in that image.  Here is an example:
- * 
+ * 
{@code
  *
  * public void handlesinglepixel(int x, int y, int pixel) {
  *      int alpha = (pixel >> 24) & 0xff;
@@ -65,7 +65,7 @@ import java.awt.Image;
  *      }
  * }
  *
- * 

+ * }

  *
  * @see ColorModel#getRGBdefault
  *
@@ -165,8 +165,8 @@ public class PixelGrabber implements ImageConsumer {
      * accumulated in the default RGB ColorModel.  If the forceRGB
      * parameter is true, then the pixels will be accumulated in the
      * default RGB ColorModel anyway.  A buffer is allocated by the
-     * PixelGrabber to hold the pixels in either case.  If (w < 0) or
-     * (h < 0), then they will default to the remaining width and
+     * PixelGrabber to hold the pixels in either case.  If {@code (w < 0)} or
+     * {@code (h < 0)}, then they will default to the remaining width and
      * height of the source data when that information is delivered.
      * @param img the image to retrieve the image data from
      * @param x the x coordinate of the upper left corner of the rectangle
@@ -233,10 +233,10 @@ public class PixelGrabber implements ImageConsumer {
      * behaves in the following ways, depending on the value of
      * ms:
      * 
    
-     * 
  •  If ms == 0, waits until all pixels are delivered
-     * 
  •  If ms > 0, waits until all pixels are delivered
+     * 
  •  If {@code ms == 0}, waits until all pixels are delivered
+     * 
  •  If {@code ms > 0}, waits until all pixels are delivered
      * as timeout expires.
-     * 
  •  If ms < 0, returns true if all pixels
+     * 
  •  If {@code ms < 0}, returns true if all pixels
      * are grabbed, false otherwise and does not wait.
      * 

      * @param ms the number of milliseconds to wait for the image pixels
diff --git a/src/share/classes/java/awt/image/RGBImageFilter.java b/src/share/classes/java/awt/image/RGBImageFilter.java
index 59d77e342..2f807ddf5 100644
--- a/src/share/classes/java/awt/image/RGBImageFilter.java
+++ b/src/share/classes/java/awt/image/RGBImageFilter.java
@@ -39,7 +39,7 @@ import java.awt.image.ColorModel;
  * The only method which needs to be defined to create a useable image
  * filter is the filterRGB method.  Here is an example of a definition
  * of a filter which swaps the red and blue components of an image:
- * 
+ * 
{@code
  *
  *      class RedBlueSwapFilter extends RGBImageFilter {
  *          public RedBlueSwapFilter() {
@@ -56,7 +56,7 @@ import java.awt.image.ColorModel;
  *          }
  *      }
  *
- * 

+ * }

  *
  * @see FilteredImageSource
  * @see ImageFilter
diff --git a/src/share/classes/java/awt/image/ShortLookupTable.java b/src/share/classes/java/awt/image/ShortLookupTable.java
index 09309e004..f0c18e087 100644
--- a/src/share/classes/java/awt/image/ShortLookupTable.java
+++ b/src/share/classes/java/awt/image/ShortLookupTable.java
@@ -114,7 +114,7 @@ public class ShortLookupTable extends LookupTable {
      * @exception ArrayIndexOutOfBoundsException if src is
      *            longer than dst or if for any element
      *            i of src,
-     *            (src[i]&0xffff)-offset is either less than
+     *            {@code (src[i]&0xffff)-offset} is either less than
      *            zero or greater than or equal to the length of the
      *            lookup table for any band.
      */
@@ -165,7 +165,7 @@ public class ShortLookupTable extends LookupTable {
      * @exception ArrayIndexOutOfBoundsException if src is
      *            longer than dst or if for any element
      *            i of src,
-     *            (src[i]&0xffff)-offset is either less than
+     *            {@code (src[i]&0xffff)-offset} is either less than
      *            zero or greater than or equal to the length of the
      *            lookup table for any band.
      */
diff --git a/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java b/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java
index b99eda6c7..58c1db0b7 100644
--- a/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java
+++ b/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java
@@ -57,10 +57,10 @@ import java.util.Arrays;
  * The following code illustrates extracting the bits of the sample
  * representing band b for pixel x,y
  * from DataBuffer data:
- * 
+ * 
{@code
  *      int sample = data.getElem(y * scanlineStride + x);
  *      sample = (sample & bitMasks[b]) >>> bitOffsets[b];
- * 

+ * }

  */
 
 public class SinglePixelPackedSampleModel extends SampleModel
diff --git a/src/share/classes/java/awt/image/WritableRaster.java b/src/share/classes/java/awt/image/WritableRaster.java
index d38d7af3f..190596af0 100644
--- a/src/share/classes/java/awt/image/WritableRaster.java
+++ b/src/share/classes/java/awt/image/WritableRaster.java
@@ -372,13 +372,13 @@ public class WritableRaster extends Raster {
      * integral type and less than or equal to 32 bits in size, then calling
      * this method is equivalent to executing the following code for all
      * x,y addresses valid in both Rasters.
-     * 
+     * 
{@code
      *       Raster srcRaster;
      *       WritableRaster dstRaster;
      *       for (int b = 0; b < srcRaster.getNumBands(); b++) {
      *           dstRaster.setSample(x, y, b, srcRaster.getSample(x, y, b));
      *       }
-     * 

+     * }

      * Thus, when copying an integral type source to an integral type
      * destination, if the source sample size is greater than the destination
      * sample size for a particular band, the high order bits of the source
-- 
GitLab