8022447: Fix doclint warnings in java.awt.image

Reviewed-by: darcy
This commit is contained in:
Phil Race 2013-08-06 17:12:37 -07:00
parent f211cb81b9
commit 753a6e3b0c
14 changed files with 44 additions and 43 deletions

View File

@ -55,7 +55,7 @@ import java.awt.Image;
* Alternatively, the contents of the back buffer can be copied, or * Alternatively, the contents of the back buffer can be copied, or
* <i>blitted</i> forward in a chain instead of moving the video pointer. * <i>blitted</i> forward in a chain instead of moving the video pointer.
* <p> * <p>
* <pre> * <pre>{@code
* Double buffering: * Double buffering:
* *
* *********** *********** * *********** ***********
@ -72,7 +72,7 @@ import java.awt.Image;
* * * <------ * * <----- * * * * * <------ * * <----- * *
* *********** *********** *********** * *********** *********** ***********
* *
* </pre> * }</pre>
* <p> * <p>
* Here is an example of how buffer strategies can be created and used: * Here is an example of how buffer strategies can be created and used:
* <pre><code> * <pre><code>

View File

@ -602,12 +602,12 @@ public class BufferedImage extends java.awt.Image
* the raster has been premultiplied with alpha. * the raster has been premultiplied with alpha.
* @param properties <code>Hashtable</code> of * @param properties <code>Hashtable</code> of
* <code>String</code>/<code>Object</code> pairs. * <code>String</code>/<code>Object</code> pairs.
* @exception <code>RasterFormatException</code> if the number and * @exception RasterFormatException if the number and
* types of bands in the <code>SampleModel</code> of the * types of bands in the <code>SampleModel</code> of the
* <code>Raster</code> do not match the number and types required by * <code>Raster</code> do not match the number and types required by
* the <code>ColorModel</code> to represent its color and alpha * the <code>ColorModel</code> to represent its color and alpha
* components. * components.
* @exception <code>IllegalArgumentException</code> if * @exception IllegalArgumentException if
* <code>raster</code> is incompatible with <code>cm</code> * <code>raster</code> is incompatible with <code>cm</code>
* @see ColorModel * @see ColorModel
* @see Raster * @see Raster
@ -927,7 +927,7 @@ public class BufferedImage extends java.awt.Image
* each color component in the returned data when * each color component in the returned data when
* using this method. With a specified coordinate (x,&nbsp;y) in the * using this method. With a specified coordinate (x,&nbsp;y) in the
* image, the ARGB pixel can be accessed in this way: * image, the ARGB pixel can be accessed in this way:
* </p> * <p>
* *
* <pre> * <pre>
* pixel = rgbArray[offset + (y-startY)*scansize + (x-startX)]; </pre> * pixel = rgbArray[offset + (y-startY)*scansize + (x-startX)]; </pre>
@ -1131,7 +1131,7 @@ public class BufferedImage extends java.awt.Image
* @return an {@link Object} that is the property referred to by the * @return an {@link Object} that is the property referred to by the
* specified <code>name</code> or <code>null</code> if the * specified <code>name</code> or <code>null</code> if the
* properties of this image are not yet known. * properties of this image are not yet known.
* @throws <code>NullPointerException</code> if the property name is null. * @throws NullPointerException if the property name is null.
* @see ImageObserver * @see ImageObserver
* @see java.awt.Image#UndefinedProperty * @see java.awt.Image#UndefinedProperty
*/ */
@ -1144,7 +1144,7 @@ public class BufferedImage extends java.awt.Image
* @param name the property name * @param name the property name
* @return an <code>Object</code> that is the property referred to by * @return an <code>Object</code> that is the property referred to by
* the specified <code>name</code>. * the specified <code>name</code>.
* @throws <code>NullPointerException</code> if the property name is null. * @throws NullPointerException if the property name is null.
*/ */
public Object getProperty(String name) { public Object getProperty(String name) {
if (name == null) { if (name == null) {
@ -1196,7 +1196,7 @@ public class BufferedImage extends java.awt.Image
* @param h the height of the specified rectangular region * @param h the height of the specified rectangular region
* @return a <code>BufferedImage</code> that is the subimage of this * @return a <code>BufferedImage</code> that is the subimage of this
* <code>BufferedImage</code>. * <code>BufferedImage</code>.
* @exception <code>RasterFormatException</code> if the specified * @exception RasterFormatException if the specified
* area is not contained within this <code>BufferedImage</code>. * area is not contained within this <code>BufferedImage</code>.
*/ */
public BufferedImage getSubimage (int x, int y, int w, int h) { 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 * @param tileY the y index of the requested tile in the tile array
* @return a <code>Raster</code> that is the tile defined by the * @return a <code>Raster</code> that is the tile defined by the
* arguments <code>tileX</code> and <code>tileY</code>. * arguments <code>tileX</code> and <code>tileY</code>.
* @exception <code>ArrayIndexOutOfBoundsException</code> if both * @exception ArrayIndexOutOfBoundsException if both
* <code>tileX</code> and <code>tileY</code> are not * <code>tileX</code> and <code>tileY</code> are not
* equal to 0 * equal to 0
*/ */
@ -1558,7 +1558,7 @@ public class BufferedImage extends java.awt.Image
* @return <code>true</code> if the tile specified by the specified * @return <code>true</code> if the tile specified by the specified
* indices is checked out for writing; <code>false</code> * indices is checked out for writing; <code>false</code>
* otherwise. * otherwise.
* @exception <code>ArrayIndexOutOfBoundsException</code> if both * @exception ArrayIndexOutOfBoundsException if both
* <code>tileX</code> and <code>tileY</code> are not equal * <code>tileX</code> and <code>tileY</code> are not equal
* to 0 * to 0
*/ */

View File

@ -171,7 +171,7 @@ public class ByteLookupTable extends LookupTable {
* @exception ArrayIndexOutOfBoundsException if <code>src</code> is * @exception ArrayIndexOutOfBoundsException if <code>src</code> is
* longer than <code>dst</code> or if for any element * longer than <code>dst</code> or if for any element
* <code>i</code> of <code>src</code>, * <code>i</code> of <code>src</code>,
* <code>(src[i]&0xff)-offset</code> is either less than * {@code (src[i]&0xff)-offset} is either less than
* zero or greater than or equal to the length of the * zero or greater than or equal to the length of the
* lookup table for any band. * lookup table for any band.
*/ */

View File

@ -692,12 +692,12 @@ public abstract class ColorModel implements Transparency{
* <code>DataBuffer.TYPE_INT</code>. * <code>DataBuffer.TYPE_INT</code>.
* @param inData an array of pixel values * @param inData an array of pixel values
* @return the value of the green component of the specified pixel. * @return the value of the green component of the specified pixel.
* @throws <code>ClassCastException</code> if <code>inData</code> * @throws ClassCastException if <code>inData</code>
* is not a primitive array of type <code>transferType</code> * is not a primitive array of type <code>transferType</code>
* @throws <code>ArrayIndexOutOfBoundsException</code> if * @throws ArrayIndexOutOfBoundsException if
* <code>inData</code> is not large enough to hold a pixel value * <code>inData</code> is not large enough to hold a pixel value
* for this <code>ColorModel</code> * for this <code>ColorModel</code>
* @throws <code>UnsupportedOperationException</code> if this * @throws UnsupportedOperationException if this
* <code>tranferType</code> is not supported by this * <code>tranferType</code> is not supported by this
* <code>ColorModel</code> * <code>ColorModel</code>
*/ */

View File

@ -642,12 +642,12 @@ public class DirectColorModel extends PackedColorModel {
* @param inData the specified pixel * @param inData the specified pixel
* @return the alpha component of the specified pixel, scaled from * @return the alpha component of the specified pixel, scaled from
* 0 to 255. * 0 to 255.
* @exception <code>ClassCastException</code> if <code>inData</code> * @exception ClassCastException if <code>inData</code>
* is not a primitive array of type <code>transferType</code> * is not a primitive array of type <code>transferType</code>
* @exception <code>ArrayIndexOutOfBoundsException</code> if * @exception ArrayIndexOutOfBoundsException if
* <code>inData</code> is not large enough to hold a pixel value * <code>inData</code> is not large enough to hold a pixel value
* for this <code>ColorModel</code> * for this <code>ColorModel</code>
* @exception <code>UnsupportedOperationException</code> if this * @exception UnsupportedOperationException if this
* <code>tranferType</code> is not supported by this * <code>tranferType</code> is not supported by this
* <code>ColorModel</code> * <code>ColorModel</code>
*/ */
@ -1055,7 +1055,7 @@ public class DirectColorModel extends PackedColorModel {
* begin retrieving the color and alpha components * begin retrieving the color and alpha components
* @return an <code>int</code> pixel value in this * @return an <code>int</code> pixel value in this
* <code>ColorModel</code> corresponding to the specified components. * <code>ColorModel</code> corresponding to the specified components.
* @exception <code>ArrayIndexOutOfBoundsException</code> if * @exception ArrayIndexOutOfBoundsException if
* the <code>components</code> array is not large enough to * the <code>components</code> array is not large enough to
* hold all of the color and alpha components starting at * hold all of the color and alpha components starting at
* <code>offset</code> * <code>offset</code>
@ -1097,9 +1097,9 @@ public class DirectColorModel extends PackedColorModel {
* and alpha components * and alpha components
* @return an <code>Object</code> representing an array of color and * @return an <code>Object</code> representing an array of color and
* alpha components. * alpha components.
* @exception <code>ClassCastException</code> if <code>obj</code> * @exception ClassCastException if <code>obj</code>
* is not a primitive array of type <code>transferType</code> * is not a primitive array of type <code>transferType</code>
* @exception <code>ArrayIndexOutOfBoundsException</code> if * @exception ArrayIndexOutOfBoundsException if
* <code>obj</code> is not large enough to hold a pixel value * <code>obj</code> is not large enough to hold a pixel value
* for this <code>ColorModel</code> or the <code>components</code> * for this <code>ColorModel</code> or the <code>components</code>
* array is not large enough to hold all of the color and alpha * array is not large enough to hold all of the color and alpha

View File

@ -100,11 +100,11 @@ public interface ImageProducer {
* <code>ImageProducer</code> should respond by executing * <code>ImageProducer</code> should respond by executing
* the following minimum set of <code>ImageConsumer</code> * the following minimum set of <code>ImageConsumer</code>
* method calls: * method calls:
* <pre> * <pre>{@code
* ic.setHints(TOPDOWNLEFTRIGHT | < otherhints >); * ic.setHints(TOPDOWNLEFTRIGHT | < otherhints >);
* ic.setPixels(...); // As many times as needed * ic.setPixels(...); // As many times as needed
* ic.imageComplete(); * ic.imageComplete();
* </pre> * }</pre>
* @param ic the specified <code>ImageConsumer</code> * @param ic the specified <code>ImageConsumer</code>
* @see ImageConsumer#setHints * @see ImageConsumer#setHints
*/ */

View File

@ -98,6 +98,7 @@ import java.math.BigInteger;
* Index values greater than or equal to the map size, but less than * Index values greater than or equal to the map size, but less than
* 2<sup><em>n</em></sup>, are undefined and return 0 for all color and * 2<sup><em>n</em></sup>, are undefined and return 0 for all color and
* alpha components. * alpha components.
* </a>
* <p> * <p>
* For those methods that use a primitive array pixel representation of * For those methods that use a primitive array pixel representation of
* type <code>transferType</code>, the array length is always one. * type <code>transferType</code>, the array length is always one.

View File

@ -37,7 +37,7 @@ import java.util.Enumeration;
* uses an array to produce pixel values for an Image. Here is an example * 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 * 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: * along the X axis and a fade from black to red along the Y axis:
* <pre> * <pre>{@code
* *
* int w = 100; * int w = 100;
* int h = 100; * int h = 100;
@ -52,12 +52,12 @@ import java.util.Enumeration;
* } * }
* Image img = createImage(new MemoryImageSource(w, h, pix, 0, w)); * Image img = createImage(new MemoryImageSource(w, h, pix, 0, w));
* *
* </pre> * }</pre>
* The MemoryImageSource is also capable of managing a memory image which * The MemoryImageSource is also capable of managing a memory image which
* varies over time to allow animation or custom rendering. Here is an * varies over time to allow animation or custom rendering. Here is an
* example showing how to set up the animation source and signal changes * example showing how to set up the animation source and signal changes
* in the data (adapted from the MemoryAnimationSourceDemo by Garth Dickie): * in the data (adapted from the MemoryAnimationSourceDemo by Garth Dickie):
* <pre> * <pre>{@code
* *
* int pixels[]; * int pixels[];
* MemoryImageSource source; * MemoryImageSource source;
@ -96,7 +96,7 @@ import java.util.Enumeration;
* } * }
* } * }
* *
* </pre> * }</pre>
* *
* @see ImageProducer * @see ImageProducer
* *

View File

@ -52,14 +52,14 @@ package java.awt.image;
* <code>x,&nbsp;y</code> from <code>DataBuffer</code> <code>data</code> * <code>x,&nbsp;y</code> from <code>DataBuffer</code> <code>data</code>
* and storing the pixel data in data elements of type * and storing the pixel data in data elements of type
* <code>dataType</code>: * <code>dataType</code>:
* <pre> * <pre>{@code
* int dataElementSize = DataBuffer.getDataTypeSize(dataType); * int dataElementSize = DataBuffer.getDataTypeSize(dataType);
* int bitnum = dataBitOffset + x*pixelBitStride; * int bitnum = dataBitOffset + x*pixelBitStride;
* int element = data.getElem(y*scanlineStride + bitnum/dataElementSize); * int element = data.getElem(y*scanlineStride + bitnum/dataElementSize);
* int shift = dataElementSize - (bitnum & (dataElementSize-1)) * int shift = dataElementSize - (bitnum & (dataElementSize-1))
* - pixelBitStride; * - pixelBitStride;
* int pixel = (element >> shift) & ((1 << pixelBitStride) - 1); * int pixel = (element >> shift) & ((1 << pixelBitStride) - 1);
* </pre> * }</pre>
*/ */
public class MultiPixelPackedSampleModel extends SampleModel public class MultiPixelPackedSampleModel extends SampleModel

View File

@ -35,7 +35,7 @@ import java.awt.Image;
* The PixelGrabber class implements an ImageConsumer which can be attached * The PixelGrabber class implements an ImageConsumer which can be attached
* to an Image or ImageProducer object to retrieve a subset of the pixels * to an Image or ImageProducer object to retrieve a subset of the pixels
* in that image. Here is an example: * in that image. Here is an example:
* <pre> * <pre>{@code
* *
* public void handlesinglepixel(int x, int y, int pixel) { * public void handlesinglepixel(int x, int y, int pixel) {
* int alpha = (pixel >> 24) & 0xff; * int alpha = (pixel >> 24) & 0xff;
@ -65,7 +65,7 @@ import java.awt.Image;
* } * }
* } * }
* *
* </pre> * }</pre>
* *
* @see ColorModel#getRGBdefault * @see ColorModel#getRGBdefault
* *
@ -165,8 +165,8 @@ public class PixelGrabber implements ImageConsumer {
* accumulated in the default RGB ColorModel. If the forceRGB * accumulated in the default RGB ColorModel. If the forceRGB
* parameter is true, then the pixels will be accumulated in the * parameter is true, then the pixels will be accumulated in the
* default RGB ColorModel anyway. A buffer is allocated by the * default RGB ColorModel anyway. A buffer is allocated by the
* PixelGrabber to hold the pixels in either case. If (w < 0) or * PixelGrabber to hold the pixels in either case. If {@code (w < 0)} or
* (h < 0), then they will default to the remaining width and * {@code (h < 0)}, then they will default to the remaining width and
* height of the source data when that information is delivered. * height of the source data when that information is delivered.
* @param img the image to retrieve the image data from * @param img the image to retrieve the image data from
* @param x the x coordinate of the upper left corner of the rectangle * @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 * behaves in the following ways, depending on the value of
* <code>ms</code>: * <code>ms</code>:
* <ul> * <ul>
* <li> If <code>ms</code> == 0, waits until all pixels are delivered * <li> If {@code ms == 0}, waits until all pixels are delivered
* <li> If <code>ms</code> > 0, waits until all pixels are delivered * <li> If {@code ms > 0}, waits until all pixels are delivered
* as timeout expires. * as timeout expires.
* <li> If <code>ms</code> < 0, returns <code>true</code> if all pixels * <li> If {@code ms < 0}, returns <code>true</code> if all pixels
* are grabbed, <code>false</code> otherwise and does not wait. * are grabbed, <code>false</code> otherwise and does not wait.
* </ul> * </ul>
* @param ms the number of milliseconds to wait for the image pixels * @param ms the number of milliseconds to wait for the image pixels

View File

@ -39,7 +39,7 @@ import java.awt.image.ColorModel;
* The only method which needs to be defined to create a useable image * 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 * 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: * of a filter which swaps the red and blue components of an image:
* <pre> * <pre>{@code
* *
* class RedBlueSwapFilter extends RGBImageFilter { * class RedBlueSwapFilter extends RGBImageFilter {
* public RedBlueSwapFilter() { * public RedBlueSwapFilter() {
@ -56,7 +56,7 @@ import java.awt.image.ColorModel;
* } * }
* } * }
* *
* </pre> * }</pre>
* *
* @see FilteredImageSource * @see FilteredImageSource
* @see ImageFilter * @see ImageFilter

View File

@ -114,7 +114,7 @@ public class ShortLookupTable extends LookupTable {
* @exception ArrayIndexOutOfBoundsException if <code>src</code> is * @exception ArrayIndexOutOfBoundsException if <code>src</code> is
* longer than <code>dst</code> or if for any element * longer than <code>dst</code> or if for any element
* <code>i</code> of <code>src</code>, * <code>i</code> of <code>src</code>,
* <code>(src[i]&0xffff)-offset</code> is either less than * {@code (src[i]&0xffff)-offset} is either less than
* zero or greater than or equal to the length of the * zero or greater than or equal to the length of the
* lookup table for any band. * lookup table for any band.
*/ */
@ -165,7 +165,7 @@ public class ShortLookupTable extends LookupTable {
* @exception ArrayIndexOutOfBoundsException if <code>src</code> is * @exception ArrayIndexOutOfBoundsException if <code>src</code> is
* longer than <code>dst</code> or if for any element * longer than <code>dst</code> or if for any element
* <code>i</code> of <code>src</code>, * <code>i</code> of <code>src</code>,
* <code>(src[i]&0xffff)-offset</code> is either less than * {@code (src[i]&0xffff)-offset} is either less than
* zero or greater than or equal to the length of the * zero or greater than or equal to the length of the
* lookup table for any band. * lookup table for any band.
*/ */

View File

@ -57,10 +57,10 @@ import java.util.Arrays;
* The following code illustrates extracting the bits of the sample * The following code illustrates extracting the bits of the sample
* representing band <code>b</code> for pixel <code>x,y</code> * representing band <code>b</code> for pixel <code>x,y</code>
* from DataBuffer <code>data</code>: * from DataBuffer <code>data</code>:
* <pre> * <pre>{@code
* int sample = data.getElem(y * scanlineStride + x); * int sample = data.getElem(y * scanlineStride + x);
* sample = (sample & bitMasks[b]) >>> bitOffsets[b]; * sample = (sample & bitMasks[b]) >>> bitOffsets[b];
* </pre> * }</pre>
*/ */
public class SinglePixelPackedSampleModel extends SampleModel public class SinglePixelPackedSampleModel extends SampleModel

View File

@ -372,13 +372,13 @@ public class WritableRaster extends Raster {
* integral type and less than or equal to 32 bits in size, then calling * 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 * this method is equivalent to executing the following code for all
* <code>x,y</code> addresses valid in both Rasters. * <code>x,y</code> addresses valid in both Rasters.
* <pre> * <pre>{@code
* Raster srcRaster; * Raster srcRaster;
* WritableRaster dstRaster; * WritableRaster dstRaster;
* for (int b = 0; b < srcRaster.getNumBands(); b++) { * for (int b = 0; b < srcRaster.getNumBands(); b++) {
* dstRaster.setSample(x, y, b, srcRaster.getSample(x, y, b)); * dstRaster.setSample(x, y, b, srcRaster.getSample(x, y, b));
* } * }
* </pre> * }</pre>
* Thus, when copying an integral type source to an integral type * Thus, when copying an integral type source to an integral type
* destination, if the source sample size is greater than the destination * destination, if the source sample size is greater than the destination
* sample size for a particular band, the high order bits of the source * sample size for a particular band, the high order bits of the source