Improved code readability

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / geometry / Rectangle.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Rectangle.java b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Rectangle.java
index 1d11e72..966d366 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Rectangle.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Rectangle.java
@@ -12,13 +12,27 @@ import static java.lang.Math.min;
  */
 public class Rectangle {
 
+    /**
+     * Rectangle points.
+     */
     public Point2D p1, p2;
 
+    /**
+     * Creates new rectangle with given size.
+     * The rectangle will be centered at the origin.
+     * The rectangle will be square.
+     *
+     * @param size The size of the rectangle.
+     */
     public Rectangle(final double size) {
         p2 = new Point2D(size / 2, size / 2);
         p1 = p2.clone().invert();
     }
 
+    /**
+     * @param p1 The first point of the rectangle.
+     * @param p2 The second point of the rectangle.
+     */
     public Rectangle(final Point2D p1, final Point2D p2) {
         this.p1 = p1;
         this.p2 = p2;
@@ -28,6 +42,9 @@ public class Rectangle {
         return abs(p1.y - p2.y);
     }
 
+    /**
+     * @return The leftmost x coordinate of the rectangle.
+     */
     public double getLowerX() {
         return min(p1.x, p2.x);
     }
@@ -36,6 +53,9 @@ public class Rectangle {
         return min(p1.y, p2.y);
     }
 
+    /**
+     * @return rectangle width.
+     */
     public double getWidth() {
         return abs(p1.x - p2.x);
     }