Changeset 9861 in josm for trunk/src

Timestamp:

2016-02-23T21:01:34+01:00 (8 years ago)

Author:

simon04

Message:

Unit test, Javadoc for LatLon

File:

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

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

@@ -205 +205 @@
 
     /**
-     * Constructs a new {@link LatLon}
+     * Constructs a new object representing the given latitude/longitude.
      * @param lat the latitude, i.e., the north-south position in degrees
      * @param lon the longitude, i.e., the east-west position in degrees
@@ -217 +217 @@
     }
 
+    /**
+     * Constructs a new object for the given coordinate
+     * @param coor the coordinate
+     */
     public LatLon(ICoordinate coor) {
         this(coor.getLat(), coor.getLon());
@@ -233 +237 @@
     public static final String NORTH = trc("compass", "N");
 
+    /**
+     * Formats the latitude part according to the given format
+     * @param d the coordinate format to use
+     * @return the formatted latitude
+     */
     public String latToString(CoordinateFormat d) {
         switch(d) {
@@ -254 +263 @@
     public static final String EAST = trc("compass", "E");
 
+    /**
+     * Formats the longitude part according to the given format
+     * @param d the coordinate format to use
+     * @return the formatted longitude
+     */
     public String lonToString(CoordinateFormat d) {
         switch(d) {
@@ -458 +472 @@
      *
      * @return rounded value
-     */
+     * @deprecated Use {@link #roundToOsmPrecision(double)} instead
+     */
+    @Deprecated
     public static double roundToOsmPrecisionStrict(double value) {
         return roundToOsmPrecision(value);
@@ -481 +497 @@
      *
      * @return a clone of this lat LatLon
-     */
+     * @deprecated Use {@link #getRoundedToOsmPrecision()} instead
+     */
+    @Deprecated
     public LatLon getRoundedToOsmPrecisionStrict() {
-        return new LatLon(
-                roundToOsmPrecisionStrict(lat()),
-                roundToOsmPrecisionStrict(lon())
-                );
+        return getRoundedToOsmPrecision();
     }
 
@@ -503 +518 @@
     }
 
+    /**
+     * Converts this latitude/longitude to an instance of {@link ICoordinate}.
+     * @return a {@link ICoordinate} instance of this latitude/longitude
+     */
     public ICoordinate toCoordinate() {
         return new org.openstreetmap.gui.jmapviewer.Coordinate(lat(), lon());