Changeset 6500 in josm for trunk/src/org/openstreetmap/josm/data/coor

Timestamp:

2013-12-19T20:56:10+01:00 (11 years ago)

Author:

simon04

Message:

Add Javadoc for LatLon, add unit tests for LatLonDialog (parsing)

File:

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

trunk/src/org/openstreetmap/josm/data/coor/LatLon.java

@@ -21 +21 @@
 /**
  * LatLon are unprojected latitude / longitude coordinates.
- *
+ * <br>
+ * <b>Latitude</b> specifies the north-south position in degrees
+ * where valid values are in the [-90,90] and positive values specify positions north of the equator.
+ * <br>
+ * <b>Longitude</b> specifies the east-west position in degrees
+ * where valid values are in the [-180,180] and positive values specify positions east of the prime meridian.
+ * <br>
+ * <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/62/Latitude_and_Longitude_of_the_Earth.svg/500px-Latitude_and_Longitude_of_the_Earth.svg.png">
+ * <br>
  * This class is immutable.
  *
@@ -41 +49 @@
      */
     public static final LatLon ZERO = new LatLon(0, 0);
-    
+
     private static DecimalFormat cDmsMinuteFormatter = new DecimalFormat("00");
     private static DecimalFormat cDmsSecondFormatter = new DecimalFormat("00.0");
@@ -160 +168 @@
     }
 
+    /**
+     * Constructs a new {@link LatLon}
+     * @param lat the latitude, i.e., the north-south position in degrees
+     * @param lon the longitude, i.e., the east-west position in degrees
+     */
     public LatLon(double lat, double lon) {
         super(lon, lat);
@@ -168 +181 @@
     }
 
+    /**
+     * Returns the latitude, i.e., the north-south position in degrees.
+     * @return the latitude
+     */
     public double lat() {
         return y;
@@ -184 +201 @@
     }
 
+    /**
+     * Returns the longitude, i.e., the east-west position in degrees.
+     * @return the longitude
+     */
     public double lon() {
         return x;
@@ -229 +250 @@
     /**
      * Check if this is contained in given area or area is null.
-     * 
+     *
      * @param a Area
      * @return <code>true</code> if this is contained in given area or area is null.
@@ -304 +325 @@
     /**
      * Returns the euclidean distance from this {@code LatLon} to a specified {@code LatLon}.
-     * 
+     *
      * @param ll the specified coordinate to be measured against this {@code LatLon}
      * @return the euclidean distance from this {@code LatLon} to a specified {@code LatLon}
@@ -315 +336 @@
     /**
      * Returns the square of the euclidean distance from this {@code LatLon} to a specified {@code LatLon}.
-     * 
+     *
      * @param ll the specified coordinate to be measured against this {@code LatLon}
      * @return the square of the euclidean distance from this {@code LatLon} to a specified {@code LatLon}