Changeset 33285 in osm for applications/viewer/jmapviewer/src/org/openstreetmap

Timestamp:

2017-05-01T16:51:11+02:00 (8 years ago)

Author:

donvip

Message:

sonar - squid:UndocumentedApi - Public types, methods and fields (API) should be documented with Javadoc

Location:

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer

Files:

• Projected.java (modified) (1 diff)
• TileRange.java (modified) (2 diffs)
• interfaces/IProjected.java (modified) (1 diff)

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/Projected.java

@@ -16 +16 @@
     private transient Point2D.Double data;
 
+    /**
+     * Constructs a new {@code Projected}.
+     * @param east easting
+     * @param north northing
+     */
     public Projected(double east, double north) {
         data = new Point2D.Double(east, north);

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/TileRange.java

@@ -15 +15 @@
     }
 
+    /**
+     * Constructs a new {@code TileRange}.
+     * @param t1 first tile
+     * @param t2 second tile
+     * @param zoom zoom level
+     */
     public TileRange(TileXY t1, TileXY t2, int zoom) {
         minX = (int) Math.floor(Math.min(t1.getX(), t2.getX()));
@@ -23 +29 @@
     }
 
+    /**
+     * Constructs a new {@code TileRange}.
+     * @param r existing tile range to copy
+     */
     public TileRange(TileRange r) {
         minX = r.minX;

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/interfaces/IProjected.java

@@ -9 +9 @@
  */
 public interface IProjected {
+    /**
+     * Returns easting.
+     * @return easting
+     */
     double getEast();
+
+    /**
+     * Returns northing.
+     * @return northing
+     */
     double getNorth();
 }
-