Changeset 9243 in josm for trunk/src/org/openstreetmap/josm/data/ProjectionBounds.java

Timestamp:

2016-01-01T19:51:11+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc update

File:

• trunk/src/org/openstreetmap/josm/data/ProjectionBounds.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/data/ProjectionBounds.java

@@ -13 +13 @@
 public class ProjectionBounds {
     /**
-     * The minimum and maximum coordinates.
+     * The minimum east coordinate.
      */
-    public double minEast, minNorth, maxEast, maxNorth;
+    public double minEast;
+    /**
+     * The minimum north coordinate.
+     */
+    public double minNorth;
+    /**
+     * The maximum east coordinate.
+     */
+    public double maxEast;
+    /**
+     * The minimum north coordinate.
+     */
+    public double maxNorth;
 
     /**
      * Construct bounds out of two points.
+     * @param min min east/north
+     * @param max max east/north
      */
     public ProjectionBounds(EastNorth min, EastNorth max) {
@@ -27 +41 @@
     }
 
+    /**
+     * Construct bounds out of a single point.
+     * @param p east/north
+     */
     public ProjectionBounds(EastNorth p) {
         this.minEast = this.maxEast = p.east();
@@ -32 +50 @@
     }
 
+    /**
+     * Construct bounds out of a center point and east/north dimensions.
+     * @param center center east/north
+     * @param east east dimension
+     * @param north north dimension
+     */
     public ProjectionBounds(EastNorth center, double east, double north) {
         this.minEast = center.east()-east/2.0;
@@ -39 +63 @@
     }
 
+    /**
+     * Construct bounds out of two points.
+     * @param minEast min east
+     * @param minNorth min north
+     * @param maxEast max east
+     * @param maxNorth max north
+     */
     public ProjectionBounds(double minEast, double minNorth, double maxEast, double maxNorth) {
         this.minEast = minEast;
@@ -46 +77 @@
     }
 
+    /**
+     * Extends bounds to include point {@code e}.
+     * @param e east/north to include
+     */
     public void extend(EastNorth e) {
         if (e.east() < minEast) {
@@ -61 +96 @@
     }
 
+    /**
+     * Returns the center east/north.
+     * @return the center east/north
+     */
     public EastNorth getCenter() {
         return new EastNorth((minEast + maxEast) / 2.0, (minNorth + maxNorth) / 2.0);
@@ -73 +112 @@
      * The two bounds intersect? Compared to java Shape.intersects, if does not use
      * the interior but the closure. ("&gt;=" instead of "&gt;")
+     * @param b projection bounds
+     * @return {@code true} if the two bounds intersect
      */
     public boolean intersects(ProjectionBounds b) {
@@ -81 +122 @@
     }
 
+    /**
+     * Returns the min east/north.
+     * @return the min east/north
+     */
     public EastNorth getMin() {
         return new EastNorth(minEast, minNorth);
     }
 
+    /**
+     * Returns the max east/north.
+     * @return the max east/north
+     */
     public EastNorth getMax() {
         return new EastNorth(maxEast, maxNorth);