Point with coordinates
* identical to the coordinates of the specified points.
*
- * @param point the point to copy the coordinates from
+ * @param p the point to copy the coordinates from
* @throws NullPointerException if p is null
*/
public Point(Point p)
Index: java/awt/Polygon.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Polygon.java,v
retrieving revision 1.9
diff -u -r1.9 Polygon.java
--- java/awt/Polygon.java 7 Apr 2004 14:30:18 -0000 1.9
+++ java/awt/Polygon.java 8 Sep 2004 18:42:28 -0000
@@ -684,7 +684,7 @@
* path iterator is not either.
*
* @param transform an optional transform to apply to the iterator
- * @param double the maximum distance for deviation from the real boundary
+ * @param flatness the maximum distance for deviation from the real boundary
* @return a new iterator over the boundary
* @since 1.2
*/
Index: java/awt/Rectangle.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Rectangle.java,v
retrieving revision 1.12
diff -u -r1.12 Rectangle.java
--- java/awt/Rectangle.java 14 Aug 2004 11:21:21 -0000 1.12
+++ java/awt/Rectangle.java 8 Sep 2004 18:42:28 -0000
@@ -338,7 +338,7 @@
* its upper left corner.
*
* @return the point where this rectangle is located
- * @see setLocation(Point)
+ * @see #setLocation(Point)
* @since 1.1
*/
public Point getLocation()
Index: java/awt/Shape.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/Shape.java,v
retrieving revision 1.5
diff -u -r1.5 Shape.java
--- java/awt/Shape.java 20 Mar 2002 04:56:08 -0000 1.5
+++ java/awt/Shape.java 8 Sep 2004 18:42:28 -0000
@@ -57,8 +57,8 @@
* @author Aaron M. Renn null not permitted).
+ *
+ * @throws NullPointerException if s is null.
*/
public Area(Shape s)
{
@@ -261,7 +265,8 @@
/**
* Performs a subtraction operation on this Area.area is null.
*/
public void subtract(Area area)
{
@@ -357,6 +362,7 @@
/**
* Performs an intersection operation on this Area.area is null.
*/
public void intersect(Area area)
{
@@ -448,6 +454,7 @@
/**
* Performs an exclusive-or operation on this Area.area is null.
*/
public void exclusiveOr(Area area)
{
@@ -666,6 +673,8 @@
/**
* Returns the bounds of this object in Rectangle format.
* Please note that this may lead to loss of precision.
+ *
+ * @return The bounds.
* @see #getBounds2D()
*/
public Rectangle getBounds()
@@ -698,8 +707,11 @@
/**
* Compares two Areas.
- *
- * @return true if the areas are equal. False otherwise.
+ *
+ * @param area the area to compare against this area (null
+ * permitted).
+ * @return true if the areas are equal, and false
+ * otherwise.
*/
public boolean equals(Area area)
{
@@ -742,7 +754,9 @@
}
/**
- * Transforms this area by the AffineTransform at
+ * Transforms this area by the AffineTransform at.
+ *
+ * @param at the transform.
*/
public void transform(AffineTransform at)
{
@@ -761,8 +775,10 @@
/**
* Returns a new Area equal to this one, transformed
- * by the AffineTransform at
+ * by the AffineTransform at.
+ * @param at the transform.
* @return the transformed area
+ * @throws NullPointerException if at is null.
*/
public Area createTransformedArea(AffineTransform at)
{
@@ -774,6 +790,8 @@
/**
* Determines if the point (x,y) is contained within this Area.
*
+ * @param x the x-coordinate of the point.
+ * @param y the y-coordinate of the point.
* @return true if the point is contained, false otherwise.
*/
public boolean contains(double x, double y)
@@ -793,7 +811,10 @@
/**
* Determines if the Point2D p is contained within this Area.
*
- * @return true if the point is contained, false otherwise.
+ * @param p the point.
+ * @return true if the point is contained, false
+ * otherwise.
+ * @throws NullPointerException if p is null.
*/
public boolean contains(Point2D p)
{
@@ -807,7 +828,12 @@
*
* This method should always produce the correct results, unlike for other
* classes in geom.
- * @return true if the rectangle is considered contained
+ *
+ * @param x the x-coordinate of the rectangle.
+ * @param y the y-coordinate of the rectangle.
+ * @param w the width of the the rectangle.
+ * @param h the height of the rectangle.
+ * @return true if the rectangle is considered contained
*/
public boolean contains(double x, double y, double w, double h)
{
@@ -859,7 +885,7 @@
Rectangle2D r = new Rectangle2D.Double(x, y, w, h);
for (int path = 0; path < holes.size(); path++)
if (! ((Segment) holes.elementAt(path)).isSegmentOutside(r))
- return false;
+ return false;
return true;
}
@@ -870,7 +896,11 @@
*
* This method should always produce the correct results, unlike for other
* classes in geom.
- * @return true if the rectangle is considered contained
+ *
+ * @param r the rectangle.
+ * @return true if the rectangle is considered contained
+ *
+ * @throws NullPointerException if r is null.
*/
public boolean contains(Rectangle2D r)
{
@@ -880,7 +910,13 @@
/**
* Determines if the rectangle specified by (x,y) as the upper-left
* and with width w and height h intersects any part of this Area.
- * @return true if the rectangle intersects the area, false otherwise.
+ *
+ * @param x the x-coordinate for the rectangle.
+ * @param y the y-coordinate for the rectangle.
+ * @param w the width of the rectangle.
+ * @param h the height of the rectangle.
+ * @return true if the rectangle intersects the area,
+ * false otherwise.
*/
public boolean intersects(double x, double y, double w, double h)
{
@@ -938,7 +974,11 @@
/**
* Determines if the Rectangle2D specified by r intersects any
* part of this Area.
- * @return true if the rectangle intersects the area, false otherwise.
+ * @param r the rectangle to test intersection with (null
+ * not permitted).
+ * @return true if the rectangle intersects the area,
+ * false otherwise.
+ * @throws NullPointerException if r is null.
*/
public boolean intersects(Rectangle2D r)
{
@@ -948,24 +988,31 @@
/**
* Returns a PathIterator object defining the contour of this Area,
* transformed by at.
+ *
+ * @param at the transform.
+ * @return A path iterator.
*/
public PathIterator getPathIterator(AffineTransform at)
{
return (new AreaIterator(at));
}
- //---------------------------------------------------------------------
- // Non-public methods and classes
-
/**
* Returns a flattened PathIterator object defining the contour of this
* Area, transformed by at and with a defined flatness.
+ *
+ * @param at the transform.
+ * @param flatness the flatness.
+ * @return A path iterator.
*/
public PathIterator getPathIterator(AffineTransform at, double flatness)
{
return new FlatteningPathIterator(getPathIterator(at), flatness);
}
+ //---------------------------------------------------------------------
+ // Non-public methods and classes
+
/**
* Private pathiterator object.
*/
Index: java/awt/geom/Ellipse2D.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/geom/Ellipse2D.java,v
retrieving revision 1.4
diff -u -r1.4 Ellipse2D.java
--- java/awt/geom/Ellipse2D.java 25 Aug 2004 01:00:48 -0000 1.4
+++ java/awt/geom/Ellipse2D.java 8 Sep 2004 18:42:29 -0000
@@ -101,6 +101,9 @@
* Note: An ellipse cannot be represented exactly in PathIterator
* segments, the outline is thefore approximated with cubic
* Bezier segments.
+ *
+ * @param at an optional transform.
+ * @return A path iterator.
*/
public PathIterator getPathIterator(AffineTransform at)
{
@@ -139,6 +142,10 @@
return false;
}
+ /**
+ * An address@hidden Ellipse2D} that stores its coordinates using double
+ * primitives.
+ */
public static class Double extends Ellipse2D
{
/**
@@ -162,7 +169,7 @@
public double y;
/**
- * Creates a new Ellipse2D with an upper-right coordinate of (0,0)
+ * Creates a new Ellipse2D with an upper-left coordinate of (0,0)
* and a zero size.
*/
public Double()
@@ -172,11 +179,10 @@
/**
* Creates a new Ellipse2D within a given rectangle
* using double-precision coordinates.
- * @param x - x coordinate of the upper-right of the bounding rectangle
- * @param y - y coordinate of the upper-right of the bounding rectangle
+ * @param x - x coordinate of the upper-left of the bounding rectangle
+ * @param y - y coordinate of the upper-left of the bounding rectangle
* @param w - width of the ellipse
* @param h - height of the ellipse
- *
*/
public Double(double x, double y, double w, double h)
{
@@ -188,6 +194,7 @@
/**
* Returns the bounding-box of the ellipse.
+ * @return The bounding box.
*/
public Rectangle2D getBounds2D()
{
@@ -196,6 +203,7 @@
/**
* Returns the height of the ellipse.
+ * @return The height of the ellipse.
*/
public double getHeight()
{
@@ -204,6 +212,7 @@
/**
* Returns the width of the ellipse.
+ * @return The width of the ellipse.
*/
public double getWidth()
{
@@ -213,6 +222,7 @@
/**
* Returns x coordinate of the upper-left corner of
* the ellipse's bounding-box.
+ * @return The x coordinate.
*/
public double getX()
{
@@ -222,6 +232,7 @@
/**
* Returns y coordinate of the upper-left corner of
* the ellipse's bounding-box.
+ * @return The y coordinate.
*/
public double getY()
{
@@ -229,7 +240,10 @@
}
/**
- * Returns true if the ellipse encloses any area.
+ * Returns true if the ellipse encloses no area, and
+ * false otherwise.
+ *
+ * @return A boolean.
*/
public boolean isEmpty()
{
@@ -239,8 +253,8 @@
/**
* Sets the geometry of the ellipse's bounding box.
*
- * @param x - x coordinate of the upper-right of the bounding rectangle
- * @param y - y coordinate of the upper-right of the bounding rectangle
+ * @param x - x coordinate of the upper-left of the bounding rectangle
+ * @param y - y coordinate of the upper-left of the bounding rectangle
* @param w - width of the ellipse
* @param h - height of the ellipse
*/
@@ -253,6 +267,10 @@
}
} // class Double
+ /**
+ * An address@hidden Ellipse2D} that stores its coordinates using float
+ * primitives.
+ */
public static class Float extends Ellipse2D
{
/**
@@ -276,7 +294,7 @@
public float y;
/**
- * Creates a new Ellipse2D with an upper-right coordinate of (0,0)
+ * Creates a new Ellipse2D with an upper-left coordinate of (0,0)
* and a zero size.
*/
public Float()
@@ -286,8 +304,8 @@
/**
* Creates a new Ellipse2D within a given rectangle
* using floating-point precision.
- * @param x - x coordinate of the upper-right of the bounding rectangle
- * @param y - y coordinate of the upper-right of the bounding rectangle
+ * @param x - x coordinate of the upper-left of the bounding rectangle
+ * @param y - y coordinate of the upper-left of the bounding rectangle
* @param w - width of the ellipse
* @param h - height of the ellipse
*
@@ -302,6 +320,7 @@
/**
* Returns the bounding-box of the ellipse.
+ * @return The bounding box.
*/
public Rectangle2D getBounds2D()
{
@@ -310,6 +329,7 @@
/**
* Returns the height of the ellipse.
+ * @return The height of the ellipse.
*/
public double getHeight()
{
@@ -318,6 +338,7 @@
/**
* Returns the width of the ellipse.
+ * @return The width of the ellipse.
*/
public double getWidth()
{
@@ -327,6 +348,7 @@
/**
* Returns x coordinate of the upper-left corner of
* the ellipse's bounding-box.
+ * @return The x coordinate.
*/
public double getX()
{
@@ -336,6 +358,7 @@
/**
* Returns y coordinate of the upper-left corner of
* the ellipse's bounding-box.
+ * @return The y coordinate.
*/
public double getY()
{
@@ -343,7 +366,10 @@
}
/**
- * Returns true if the ellipse encloses any area.
+ * Returns true if the ellipse encloses no area, and
+ * false otherwise.
+ *
+ * @return A boolean.
*/
public boolean isEmpty()
{
@@ -353,8 +379,8 @@
/**
* Sets the geometry of the ellipse's bounding box.
* - * @param x - x coordinate of the upper-right of the bounding rectangle - * @param y - y coordinate of the upper-right of the bounding rectangle + * @param x - x coordinate of the upper-left of the bounding rectangle + * @param y - y coordinate of the upper-left of the bounding rectangle * @param w - width of the ellipse * @param h - height of the ellipse */ @@ -371,8 +397,8 @@ * * Note: This leads to a loss of precision.
*
- * @param x - x coordinate of the upper-right of the bounding rectangle
- * @param y - y coordinate of the upper-right of the bounding rectangle
+ * @param x - x coordinate of the upper-left of the bounding rectangle
+ * @param y - y coordinate of the upper-left of the bounding rectangle
* @param w - width of the ellipse
* @param h - height of the ellipse
*/
Index: java/awt/geom/PathIterator.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/awt/geom/PathIterator.java,v
retrieving revision 1.8
diff -u -r1.8 PathIterator.java
--- java/awt/geom/PathIterator.java 9 Jan 2004 08:59:30 -0000 1.8
+++ java/awt/geom/PathIterator.java 8 Sep 2004 18:42:29 -0000
@@ -46,8 +46,8 @@
*
* @author Tom Tromey Lists, arrays, and sets of objects that implement this interface can
* be sorted automatically, without the need for an explicit
- * address@hidden Comparator}. Note that e1.compareTo(null) should
- * throw an Exception; as should comparison between incompatible classes.
+ * address@hidden java.util.Comparator}. Note that e1.compareTo(null)
+ * should throw an Exception; as should comparison between incompatible
+ * classes.
*
* @author Geoff Berry
* @author Warren Levy