Changeset 9477 in josm for trunk/src

Timestamp:

2016-01-16T01:18:11+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc fixes

Location:

trunk/src/org/openstreetmap/josm

Files:

• io/GpxImporter.java (modified) (3 diffs)
• tools/Utils.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/io/GpxImporter.java

@@ -42 +42 @@
         private final Runnable postLayerTask;
 
+        /**
+         * Constructs a new {@code GpxImporterData}.
+         * @param gpxLayer The imported GPX layer. May be null if no GPX data.
+         * @param markerLayer The imported marker layer. May be null if no marker.
+         * @param postLayerTask The task to run after GPX and/or marker layer has been added to MapView.
+         */
         public GpxImporterData(GpxLayer gpxLayer, MarkerLayer markerLayer, Runnable postLayerTask) {
             this.gpxLayer = gpxLayer;
@@ -48 +54 @@
         }
 
+        /**
+         * Returns the imported GPX layer. May be null if no GPX data.
+         * @return the imported GPX layer. May be null if no GPX data.
+         */
         public GpxLayer getGpxLayer() {
             return gpxLayer;
         }
 
+        /**
+         * Returns the imported marker layer. May be null if no marker.
+         * @return the imported marker layer. May be null if no marker.
+         */
         public MarkerLayer getMarkerLayer() {
             return markerLayer;
         }
 
+        /**
+         * Returns the task to run after GPX and/or marker layer has been added to MapView.
+         * @return the task to run after GPX and/or marker layer has been added to MapView.
+         */
         public Runnable getPostLayerTask() {
             return postLayerTask;
@@ -70 +88 @@
     /**
      * Returns a GPX file filter (*.gpx and *.gpx.gz files).
+     * @return a GPX file filter
      */
     public static ExtensionFileFilter getFileFilter() {

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -1314 +1314 @@
      * If the collection {@code elements} is larger than {@code maxElements} elements,
      * the collection is shortened and the {@code overflowIndicator} is appended.
+     * @param <T> type of elements
      * @param elements collection to shorten
      * @param maxElements maximum number of elements to keep (including including the {@code overflowIndicator})