Ignore:
Timestamp:
2016-01-01T19:51:11+01:00 (4 years ago)
Author:
Don-vip
Message:

javadoc update

Location:
trunk/src/org/openstreetmap/josm/data/coor
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/coor/EastNorth.java

    r8906 r9243  
    156156    /**
    157157     * Compares two EastNorth values
     158     * @param other other east.north
     159     * @param e epsilon
    158160     *
    159      * @return true if "x" and "y" values are within 1E-6 of each other
     161     * @return true if "x" and "y" values are within epsilon {@code e} of each other
    160162     */
    161163    public boolean equalsEpsilon(EastNorth other, double e) {
  • trunk/src/org/openstreetmap/josm/data/coor/LatLon.java

    r8846 r9243  
    115115     * For example, a value of -181 will return +179, a value of +181 will return -179.
    116116     * @param value A longitude value not restricted to the [-180,+180] range.
     117     * @return a valid OSM longitude [-180,+180]
    117118     */
    118119    public static double toIntervalLon(double value) {
     
    237238
    238239    /**
     240     * @param other other lat/lon
    239241     * @return <code>true</code> if the other point has almost the same lat/lon
    240      * values, only differing by no more than
    241      * 1 / {@link #MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
     242     * values, only differing by no more than 1 / {@link #MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
    242243     */
    243244    public boolean equalsEpsilon(LatLon other) {
     
    247248
    248249    /**
    249      * @return <code>true</code>, if the coordinate is outside the world, compared
    250      * by using lat/lon.
     250     * Determines if this lat/lon is outside of the world
     251     * @return <code>true</code>, if the coordinate is outside the world, compared by using lat/lon.
    251252     */
    252253    public boolean isOutSideWorld() {
     
    257258
    258259    /**
     260     * Determines if this lat/lon is within the given bounding box.
     261     * @param b bounding box
    259262     * @return <code>true</code> if this is within the given bounding box.
    260263     */
     
    330333    /**
    331334     * Returns this lat/lon pair in human-readable format separated by {@code separator}.
     335     * @param separator values separator
    332336     * @return String in the format {@code "1.23456[separator]2.34567"}
    333337     */
     
    376380
    377381    /**
    378      * Returns the value rounded to OSM precisions, i.e. to
    379      * LatLon.MAX_SERVER_PRECISION
     382     * Returns the value rounded to OSM precisions, i.e. to {@link LatLon#MAX_SERVER_PRECISION}.
     383     * @param value lat/lon value
    380384     *
    381385     * @return rounded value
     
    388392     * Returns the value rounded to OSM precision. This function is now the same as
    389393     * {@link #roundToOsmPrecision(double)}, since the rounding error has been fixed.
     394     * @param value lat/lon value
    390395     *
    391396     * @return rounded value
Note: See TracChangeset for help on using the changeset viewer.