Changeset 12378 in josm for trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java

Timestamp:

2017-06-09T22:13:45+02:00 (7 years ago)

Author:

michael2402

Message:

Document the gui.mappaint package

File:

• trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java

@@ -13 +13 @@
     private final double upper;
 
+    /**
+     * The full scale range from zero to infinity
+     */
     public static final Range ZERO_TO_INFINITY = new Range(0.0, Double.POSITIVE_INFINITY);
 
@@ -28 +31 @@
     }
 
+    /**
+     * Check if a number is contained in this range
+     * @param x The number to test
+     * @return <code>true</code> if it is in this range
+     */
     public boolean contains(double x) {
         return lower < x && x <= upper;
@@ -76 +84 @@
     }
 
+    /**
+     * Gets the lower bound
+     * @return The lower, exclusive, bound
+     */
     public double getLower() {
         return lower;
     }
 
+    /**
+     * Gets the upper bound
+     * @return The upper, inclusive, bound
+     */
     public double getUpper() {
         return upper;