Changeset 9243 in josm for trunk/src/org/openstreetmap/josm/gui/layer/geoimage

Timestamp:

2016-01-01T19:51:11+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc update

Location:

trunk/src/org/openstreetmap/josm/gui/layer/geoimage

Files:

• CorrelateGpxWithImages.java (modified) (1 diff)
• GeoImageLayer.java (modified) (1 diff)
• ImageEntry.java (modified) (9 diffs)

trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java

@@ -1144 +1144 @@
      * Match a list of photos to a gpx track with a given offset.
      * All images need a exifTime attribute and the List must be sorted according to these times.
+     * @param images images to match
+     * @param selectedGpx selected GPX data
+     * @param offset offset
+     * @return number of matched points
      */
     private int matchGpxTrack(List<ImageEntry> images, GpxData selectedGpx, long offset) {

trunk/src/org/openstreetmap/josm/gui/layer/geoimage/GeoImageLayer.java

@@ -598 +598 @@
      *
      * If successful, fills in the LatLon and EastNorth attributes of passed in image
+     * @param e image entry
      */
     private static void extractExif(ImageEntry e) {

trunk/src/org/openstreetmap/josm/gui/layer/geoimage/ImageEntry.java

@@ -51 +51 @@
 
     /**
-     * getter methods that refer to the temporary value
+     * Returns the cached temporary position value.
+     * @return the cached temporary position value
      */
     public CachedLatLon getPos() {
@@ -59 +60 @@
     }
 
+    /**
+     * Returns the cached temporary speed value.
+     * @return the cached temporary speed value
+     */
     public Double getSpeed() {
         if (tmp != null)
@@ -65 +70 @@
     }
 
+    /**
+     * Returns the cached temporary elevation value.
+     * @return the cached temporary elevation value
+     */
     public Double getElevation() {
         if (tmp != null)
@@ -71 +80 @@
     }
 
+    /**
+     * Returns the cached temporary GPS time value.
+     * @return the cached temporary GPS time value
+     */
     public Date getGpsTime() {
         if (tmp != null)
@@ -87 +100 @@
 
     /**
-     * other getter methods
+     * Returns associated file.
+     * @return associated file
      */
     public File getFile() {
@@ -93 +107 @@
     }
 
+    /**
+     * Returns EXIF orientation
+     * @return EXIF orientation
+     */
     public Integer getExifOrientation() {
         return exifOrientation;
     }
 
+    /**
+     * Returns EXIF time
+     * @return EXIF time
+     */
     public Date getExifTime() {
         return getDefensiveDate(exifTime);
@@ -147 +169 @@
 
     /**
-     * setter methods
+     * Sets the position.
+     * @param pos cached position
      */
     public void setPos(CachedLatLon pos) {
@@ -153 +176 @@
     }
 
+    /**
+     * Sets the position.
+     * @param pos position (will be cached)
+     */
     public void setPos(LatLon pos) {
-        this.pos = new CachedLatLon(pos);
-    }
-
+        setPos(new CachedLatLon(pos));
+    }
+
+    /**
+     * Sets the speed.
+     * @param speed speed
+     */
     public void setSpeed(Double speed) {
         this.speed = speed;
     }
 
+    /**
+     * Sets the elevation.
+     * @param elevation elevation
+     */
     public void setElevation(Double elevation) {
         this.elevation = elevation;
     }
 
+    /**
+     * Sets associated file.
+     * @param file associated file
+     */
     public void setFile(File file) {
         this.file = file;
     }
 
+    /**
+     * Sets EXIF orientation.
+     * @param exifOrientation EXIF orientation
+     */
     public void setExifOrientation(Integer exifOrientation) {
         this.exifOrientation = exifOrientation;
     }
 
+    /**
+     * Sets EXIF time.
+     * @param exifTime EXIF time
+     */
     public void setExifTime(Date exifTime) {
         this.exifTime = getDefensiveDate(exifTime);
@@ -245 +292 @@
     /**
      * If it has been tagged i.e. matched to a gpx track or retrieved lat/lon from exif
+     * @return {@code true} if it has been tagged
      */
     public boolean isTagged() {