diff --git a/src/main/java/pythagoras/d/AffineTransform.java b/src/main/java/pythagoras/d/AffineTransform.java index d3abe6c..5f87e49 100644 --- a/src/main/java/pythagoras/d/AffineTransform.java +++ b/src/main/java/pythagoras/d/AffineTransform.java @@ -10,7 +10,7 @@ import java.io.Serializable; * Represents a 2D affine transform, which performs a linear mapping that preserves the * straightness and parallelness of lines. * - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/AffineTransform.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/AffineTransform.html */ public class AffineTransform implements Cloneable, Serializable { diff --git a/src/main/java/pythagoras/d/Area.java b/src/main/java/pythagoras/d/Area.java index e2652b1..ef16124 100644 --- a/src/main/java/pythagoras/d/Area.java +++ b/src/main/java/pythagoras/d/Area.java @@ -8,7 +8,7 @@ import java.util.NoSuchElementException; /** * Stores and manipulates an enclosed area of 2D space. - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/Area.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/Area.html */ public class Area implements IShape, Cloneable { diff --git a/src/main/java/pythagoras/d/CubicCurve.java b/src/main/java/pythagoras/d/CubicCurve.java index a27f93f..dd89cba 100644 --- a/src/main/java/pythagoras/d/CubicCurve.java +++ b/src/main/java/pythagoras/d/CubicCurve.java @@ -74,7 +74,7 @@ public class CubicCurve extends AbstractCubicCurve implements Serializable /** * Configures the start, control and end points for this curve, using the values at the - * specified offset in the {@link coords} array. + * specified offset in the {@code coords} array. */ public void setCurve (double[] coords, int offset) { setCurve(coords[offset + 0], coords[offset + 1], coords[offset + 2], coords[offset + 3], @@ -83,7 +83,7 @@ public class CubicCurve extends AbstractCubicCurve implements Serializable /** * Configures the start, control and end points for this curve, using the values at the - * specified offset in the {@link points} array. + * specified offset in the {@code points} array. */ public void setCurve (IPoint[] points, int offset) { setCurve(points[offset + 0].getX(), points[offset + 0].getY(), diff --git a/src/main/java/pythagoras/d/IRectangularShape.java b/src/main/java/pythagoras/d/IRectangularShape.java index 5685d08..51fa0fe 100644 --- a/src/main/java/pythagoras/d/IRectangularShape.java +++ b/src/main/java/pythagoras/d/IRectangularShape.java @@ -5,7 +5,7 @@ package pythagoras.d; /** - * An interface implemented by {@link Shape} classes whose geometry is defined by a rectangular + * An interface implemented by {@link IShape} classes whose geometry is defined by a rectangular * frame. The framing rectangle defines the geometry, but may in some cases differ from * the bounding rectangle of the shape. */ diff --git a/src/main/java/pythagoras/d/Lines.java b/src/main/java/pythagoras/d/Lines.java index 65c6be1..69bdb33 100644 --- a/src/main/java/pythagoras/d/Lines.java +++ b/src/main/java/pythagoras/d/Lines.java @@ -128,7 +128,7 @@ public class Lines * Returns an indicator of where the specified point (px,py) lies with respect to the line * segment from (x1,y1) to (x2,y2). * - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/Line2D.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/Line2D.html */ public static int relativeCCW (double px, double py, double x1, double y1, double x2, double y2) { diff --git a/src/main/java/pythagoras/d/PathIterator.java b/src/main/java/pythagoras/d/PathIterator.java index 7687c04..b0c2f65 100644 --- a/src/main/java/pythagoras/d/PathIterator.java +++ b/src/main/java/pythagoras/d/PathIterator.java @@ -5,7 +5,7 @@ package pythagoras.d; /** - * Used to return the boundary of a {@link IShape}, one segment at a time. + * Used to return the boundary of an {@link IShape}, one segment at a time. */ public interface PathIterator { diff --git a/src/main/java/pythagoras/d/QuadCurve.java b/src/main/java/pythagoras/d/QuadCurve.java index 9ba01a7..f6e456d 100644 --- a/src/main/java/pythagoras/d/QuadCurve.java +++ b/src/main/java/pythagoras/d/QuadCurve.java @@ -63,7 +63,7 @@ public class QuadCurve extends AbstractQuadCurve implements Serializable /** * Configures the start, control, and end points for this curve, using the values at the - * specified offset in the {@link coords} array. + * specified offset in the {@code coords} array. */ public void setCurve (double[] coords, int offset) { setCurve(coords[offset + 0], coords[offset + 1], @@ -73,7 +73,7 @@ public class QuadCurve extends AbstractQuadCurve implements Serializable /** * Configures the start, control, and end points for this curve, using the values at the - * specified offset in the {@link points} array. + * specified offset in the {@code points} array. */ public void setCurve (IPoint[] points, int offset) { setCurve(points[offset + 0].getX(), points[offset + 0].getY(), diff --git a/src/main/java/pythagoras/d/Rectangles.java b/src/main/java/pythagoras/d/Rectangles.java index 726d8aa..cc33c64 100644 --- a/src/main/java/pythagoras/d/Rectangles.java +++ b/src/main/java/pythagoras/d/Rectangles.java @@ -10,7 +10,7 @@ package pythagoras.d; public class Rectangles { /** - * Intersects the supplied two rectangles, writing the result into {@link dst}. + * Intersects the supplied two rectangles, writing the result into {@code dst}. */ public static void intersect (IRectangle src1, IRectangle src2, Rectangle dst) { double x1 = Math.max(src1.getMinX(), src2.getMinX()); @@ -21,7 +21,7 @@ public class Rectangles } /** - * Unions the supplied two rectangles, writing the result into {@link dst}. + * Unions the supplied two rectangles, writing the result into {@code dst}. */ public static void union (IRectangle src1, IRectangle src2, Rectangle dst) { double x1 = Math.min(src1.getMinX(), src2.getMinX()); diff --git a/src/main/java/pythagoras/d/RectangularShape.java b/src/main/java/pythagoras/d/RectangularShape.java index 7790279..de70305 100644 --- a/src/main/java/pythagoras/d/RectangularShape.java +++ b/src/main/java/pythagoras/d/RectangularShape.java @@ -5,7 +5,7 @@ package pythagoras.d; /** - * The base class for various {@link Shape} objects whose geometry is defined by a rectangular + * The base class for various {@link IShape} objects whose geometry is defined by a rectangular * frame. */ public abstract class RectangularShape implements IRectangularShape diff --git a/src/main/java/pythagoras/d/package-info.java b/src/main/java/pythagoras/d/package-info.java new file mode 100644 index 0000000..bea38ff --- /dev/null +++ b/src/main/java/pythagoras/d/package-info.java @@ -0,0 +1,4 @@ +/** + * The Pythagoras geometry utility classes specialized on {@code double}. + */ +package pythagoras.d; diff --git a/src/main/java/pythagoras/f/AffineTransform.java b/src/main/java/pythagoras/f/AffineTransform.java index 43ae19f..34f8a12 100644 --- a/src/main/java/pythagoras/f/AffineTransform.java +++ b/src/main/java/pythagoras/f/AffineTransform.java @@ -10,7 +10,7 @@ import java.io.Serializable; * Represents a 2D affine transform, which performs a linear mapping that preserves the * straightness and parallelness of lines. * - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/AffineTransform.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/AffineTransform.html */ public class AffineTransform implements Cloneable, Serializable { diff --git a/src/main/java/pythagoras/f/Area.java b/src/main/java/pythagoras/f/Area.java index b02a909..294ea9c 100644 --- a/src/main/java/pythagoras/f/Area.java +++ b/src/main/java/pythagoras/f/Area.java @@ -8,7 +8,7 @@ import java.util.NoSuchElementException; /** * Stores and manipulates an enclosed area of 2D space. - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/Area.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/Area.html */ public class Area implements IShape, Cloneable { diff --git a/src/main/java/pythagoras/f/CubicCurve.java b/src/main/java/pythagoras/f/CubicCurve.java index 89e1645..de3088a 100644 --- a/src/main/java/pythagoras/f/CubicCurve.java +++ b/src/main/java/pythagoras/f/CubicCurve.java @@ -74,7 +74,7 @@ public class CubicCurve extends AbstractCubicCurve implements Serializable /** * Configures the start, control and end points for this curve, using the values at the - * specified offset in the {@link coords} array. + * specified offset in the {@code coords} array. */ public void setCurve (float[] coords, int offset) { setCurve(coords[offset + 0], coords[offset + 1], coords[offset + 2], coords[offset + 3], @@ -83,7 +83,7 @@ public class CubicCurve extends AbstractCubicCurve implements Serializable /** * Configures the start, control and end points for this curve, using the values at the - * specified offset in the {@link points} array. + * specified offset in the {@code points} array. */ public void setCurve (IPoint[] points, int offset) { setCurve(points[offset + 0].getX(), points[offset + 0].getY(), diff --git a/src/main/java/pythagoras/f/IRectangularShape.java b/src/main/java/pythagoras/f/IRectangularShape.java index 7969295..5b3fdae 100644 --- a/src/main/java/pythagoras/f/IRectangularShape.java +++ b/src/main/java/pythagoras/f/IRectangularShape.java @@ -5,7 +5,7 @@ package pythagoras.f; /** - * An interface implemented by {@link Shape} classes whose geometry is defined by a rectangular + * An interface implemented by {@link IShape} classes whose geometry is defined by a rectangular * frame. The framing rectangle defines the geometry, but may in some cases differ from * the bounding rectangle of the shape. */ diff --git a/src/main/java/pythagoras/f/Lines.java b/src/main/java/pythagoras/f/Lines.java index 66cebc8..f9d2bd8 100644 --- a/src/main/java/pythagoras/f/Lines.java +++ b/src/main/java/pythagoras/f/Lines.java @@ -126,7 +126,7 @@ public class Lines * Returns an indicator of where the specified point (px,py) lies with respect to the line * segment from (x1,y1) to (x2,y2). * - * @see http://download.oracle.com/javase/6/docs/api/java/awt/geom/Line2D.html + * See http://download.oracle.com/javase/6/docs/api/java/awt/geom/Line2D.html */ public static int relativeCCW (float px, float py, float x1, float y1, float x2, float y2) { // A = (x2-x1, y2-y1) diff --git a/src/main/java/pythagoras/f/PathIterator.java b/src/main/java/pythagoras/f/PathIterator.java index 370cd7c..f4e452a 100644 --- a/src/main/java/pythagoras/f/PathIterator.java +++ b/src/main/java/pythagoras/f/PathIterator.java @@ -5,7 +5,7 @@ package pythagoras.f; /** - * Used to return the boundary of a {@link IShape}, one segment at a time. + * Used to return the boundary of an {@link IShape}, one segment at a time. */ public interface PathIterator { diff --git a/src/main/java/pythagoras/f/QuadCurve.java b/src/main/java/pythagoras/f/QuadCurve.java index fbcd278..1c67c67 100644 --- a/src/main/java/pythagoras/f/QuadCurve.java +++ b/src/main/java/pythagoras/f/QuadCurve.java @@ -63,7 +63,7 @@ public class QuadCurve extends AbstractQuadCurve implements Serializable /** * Configures the start, control, and end points for this curve, using the values at the - * specified offset in the {@link coords} array. + * specified offset in the {@code coords} array. */ public void setCurve (float[] coords, int offset) { setCurve(coords[offset + 0], coords[offset + 1], @@ -73,7 +73,7 @@ public class QuadCurve extends AbstractQuadCurve implements Serializable /** * Configures the start, control, and end points for this curve, using the values at the - * specified offset in the {@link points} array. + * specified offset in the {@code points} array. */ public void setCurve (IPoint[] points, int offset) { setCurve(points[offset + 0].getX(), points[offset + 0].getY(), diff --git a/src/main/java/pythagoras/f/Rectangles.java b/src/main/java/pythagoras/f/Rectangles.java index de0676d..be20614 100644 --- a/src/main/java/pythagoras/f/Rectangles.java +++ b/src/main/java/pythagoras/f/Rectangles.java @@ -10,7 +10,7 @@ package pythagoras.f; public class Rectangles { /** - * Intersects the supplied two rectangles, writing the result into {@link dst}. + * Intersects the supplied two rectangles, writing the result into {@code dst}. */ public static void intersect (IRectangle src1, IRectangle src2, Rectangle dst) { float x1 = Math.max(src1.getMinX(), src2.getMinX()); @@ -21,7 +21,7 @@ public class Rectangles } /** - * Unions the supplied two rectangles, writing the result into {@link dst}. + * Unions the supplied two rectangles, writing the result into {@code dst}. */ public static void union (IRectangle src1, IRectangle src2, Rectangle dst) { float x1 = Math.min(src1.getMinX(), src2.getMinX()); diff --git a/src/main/java/pythagoras/f/RectangularShape.java b/src/main/java/pythagoras/f/RectangularShape.java index 1d0e608..0ef2aa8 100644 --- a/src/main/java/pythagoras/f/RectangularShape.java +++ b/src/main/java/pythagoras/f/RectangularShape.java @@ -5,7 +5,7 @@ package pythagoras.f; /** - * The base class for various {@link Shape} objects whose geometry is defined by a rectangular + * The base class for various {@link IShape} objects whose geometry is defined by a rectangular * frame. */ public abstract class RectangularShape implements IRectangularShape diff --git a/src/main/java/pythagoras/f/package-info.java b/src/main/java/pythagoras/f/package-info.java new file mode 100644 index 0000000..5a38390 --- /dev/null +++ b/src/main/java/pythagoras/f/package-info.java @@ -0,0 +1,4 @@ +/** + * The Pythagoras geometry utility classes specialized on {@code float}. + */ +package pythagoras.f; diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000..ebdfb45 --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,12 @@ + + + + +

Pythagoras is a collection of geometry classes for use on platforms that do not vend their own +such classes (for example, GWT and Android).

+ +

The source code, and additional information can be found on the +project website.

+ + +