# HG changeset patch # User prr # Date 1375834357 25200 # Node ID 1807a84c3d630671bc5416a042a68c170e964094 # Parent ff364494f2b8888612fc48e71808874cae1a378b 8022447: Fix doclint warnings in java.awt.image Reviewed-by: darcy diff -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/BufferStrategy.java --- a/jdk/src/share/classes/java/awt/image/BufferStrategy.java Tue Aug 06 17:11:29 2013 -0700 +++ b/jdk/src/share/classes/java/awt/image/BufferStrategy.java Tue Aug 06 17:12:37 2013 -0700 @@ -55,7 +55,7 @@ * 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 @@ * * * <------ * * <----- * * * *********** *********** *********** * - *+ * }
* Here is an example of how buffer strategies can be created and used: *
diff -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/BufferedImage.java
--- a/jdk/src/share/classes/java/awt/image/BufferedImage.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/BufferedImage.java Tue Aug 06 17:12:37 2013 -0700
@@ -602,12 +602,12 @@
* 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 @@
* 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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/ByteLookupTable.java
--- a/jdk/src/share/classes/java/awt/image/ByteLookupTable.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/ByteLookupTable.java Tue Aug 06 17:12:37 2013 -0700
@@ -171,7 +171,7 @@
* @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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/ColorModel.java
--- a/jdk/src/share/classes/java/awt/image/ColorModel.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/ColorModel.java Tue Aug 06 17:12:37 2013 -0700
@@ -692,12 +692,12 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/DirectColorModel.java
--- a/jdk/src/share/classes/java/awt/image/DirectColorModel.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/DirectColorModel.java Tue Aug 06 17:12:37 2013 -0700
@@ -642,12 +642,12 @@
* @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 @@
* 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 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/ImageProducer.java
--- a/jdk/src/share/classes/java/awt/image/ImageProducer.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/ImageProducer.java Tue Aug 06 17:12:37 2013 -0700
@@ -100,11 +100,11 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/IndexColorModel.java
--- a/jdk/src/share/classes/java/awt/image/IndexColorModel.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/IndexColorModel.java Tue Aug 06 17:12:37 2013 -0700
@@ -98,6 +98,7 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/MemoryImageSource.java
--- a/jdk/src/share/classes/java/awt/image/MemoryImageSource.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/MemoryImageSource.java Tue Aug 06 17:12:37 2013 -0700
@@ -37,7 +37,7 @@
* 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 @@
* }
* 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 @@
* }
* }
*
- *
+ * }
*
* @see ImageProducer
*
diff -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java
--- a/jdk/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java Tue Aug 06 17:12:37 2013 -0700
@@ -52,14 +52,14 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/PixelGrabber.java
--- a/jdk/src/share/classes/java/awt/image/PixelGrabber.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/PixelGrabber.java Tue Aug 06 17:12:37 2013 -0700
@@ -35,7 +35,7 @@
* 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 @@
* }
* }
*
- *
+ * }
*
* @see ColorModel#getRGBdefault
*
@@ -165,8 +165,8 @@
* 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 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/RGBImageFilter.java
--- a/jdk/src/share/classes/java/awt/image/RGBImageFilter.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/RGBImageFilter.java Tue Aug 06 17:12:37 2013 -0700
@@ -39,7 +39,7 @@
* 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 @@
* }
* }
*
- *
+ * }
*
* @see FilteredImageSource
* @see ImageFilter
diff -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/ShortLookupTable.java
--- a/jdk/src/share/classes/java/awt/image/ShortLookupTable.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/ShortLookupTable.java Tue Aug 06 17:12:37 2013 -0700
@@ -114,7 +114,7 @@
* @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 @@
* @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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java
--- a/jdk/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/SinglePixelPackedSampleModel.java Tue Aug 06 17:12:37 2013 -0700
@@ -57,10 +57,10 @@
* 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 -r ff364494f2b8 -r 1807a84c3d63 jdk/src/share/classes/java/awt/image/WritableRaster.java
--- a/jdk/src/share/classes/java/awt/image/WritableRaster.java Tue Aug 06 17:11:29 2013 -0700
+++ b/jdk/src/share/classes/java/awt/image/WritableRaster.java Tue Aug 06 17:12:37 2013 -0700
@@ -372,13 +372,13 @@
* 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