Changeset 10699 in josm for trunk/src/org/openstreetmap/josm/data/projection/AbstractProjection.java

Timestamp:

2016-08-01T23:01:45+02:00 (8 years ago)

Author:

Don-vip

Message:

fix #13255 - Document AbstractProjection (patch by michael2402) - gsoc-core

File:

• trunk/src/org/openstreetmap/josm/data/projection/AbstractProjection.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/projection/AbstractProjection.java

@@ -37 +37 @@
     private volatile ProjectionBounds projectionBoundsBox;
 
+    /**
+     * Get the base ellipsoid that this projection uses.
+     * @return The {@link Ellipsoid}
+     */
     public final Ellipsoid getEllipsoid() {
         return ellps;
     }
 
+    /**
+     * Gets the datum this projection is based on.
+     * @return The datum
+     */
     public final Datum getDatum() {
         return datum;
@@ -53 +61 @@
     }
 
+    /**
+     * Gets an east offset that gets applied when converting the coordinate
+     * @return The offset to apply in meter
+     */
     public final double getFalseEasting() {
         return x0;
     }
 
+    /**
+     * Gets an north offset that gets applied when converting the coordinate
+     * @return The offset to apply in meter
+     */
     public final double getFalseNorthing() {
         return y0;
     }
 
+    /**
+     * Gets the meridian that this projection is centered on.
+     * @return The longitude of the meridian.
+     */
     public final double getCentralMeridian() {
         return lon0;
@@ -76 +96 @@
      * be in meters as well. This factor is used to convert to the intended units
      * of east/north coordinates (e.g. feet in the US).
-     * 
+     *
      * For geographic coordinate systems, the preliminary "projection" result will
      * be in degrees, so there is no reason to convert anything and this factor