Changeset 9243 in josm for trunk/src/org/openstreetmap/josm/data/coor/LatLon.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/coor/LatLon.java (modified) (7 diffs)

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

@@ -115 +115 @@
      * For example, a value of -181 will return +179, a value of +181 will return -179.
      * @param value A longitude value not restricted to the [-180,+180] range.
+     * @return a valid OSM longitude [-180,+180]
      */
     public static double toIntervalLon(double value) {
@@ -237 +238 @@
 
     /**
+     * @param other other lat/lon
      * @return <code>true</code> if the other point has almost the same lat/lon
-     * values, only differing by no more than
-     * 1 / {@link #MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
+     * values, only differing by no more than 1 / {@link #MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
      */
     public boolean equalsEpsilon(LatLon other) {
@@ -247 +248 @@
 
     /**
-     * @return <code>true</code>, if the coordinate is outside the world, compared
-     * by using lat/lon.
+     * Determines if this lat/lon is outside of the world
+     * @return <code>true</code>, if the coordinate is outside the world, compared by using lat/lon.
      */
     public boolean isOutSideWorld() {
@@ -257 +258 @@
 
     /**
+     * Determines if this lat/lon is within the given bounding box.
+     * @param b bounding box
      * @return <code>true</code> if this is within the given bounding box.
      */
@@ -330 +333 @@
     /**
      * Returns this lat/lon pair in human-readable format separated by {@code separator}.
+     * @param separator values separator
      * @return String in the format {@code "1.23456[separator]2.34567"}
      */
@@ -376 +380 @@
 
     /**
-     * Returns the value rounded to OSM precisions, i.e. to
-     * LatLon.MAX_SERVER_PRECISION
+     * Returns the value rounded to OSM precisions, i.e. to {@link LatLon#MAX_SERVER_PRECISION}.
+     * @param value lat/lon value
      *
      * @return rounded value
@@ -388 +392 @@
      * Returns the value rounded to OSM precision. This function is now the same as
      * {@link #roundToOsmPrecision(double)}, since the rounding error has been fixed.
+     * @param value lat/lon value
      *
      * @return rounded value