Changeset 9246 in josm for trunk/src/org/openstreetmap/josm/gui/io

Timestamp:

2016-01-01T22:21:21+01:00 (8 years ago)

Author:

Don-vip

Message:

javadoc update

Location:

trunk/src/org/openstreetmap/josm/gui/io

Files:

• AbstractUploadTask.java (modified) (3 diffs)
• LayerNameAndFilePathTableCell.java (modified) (3 diffs)
• TagSettingsPanel.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/io/AbstractUploadTask.java

@@ -53 +53 @@
      * Synchronizes the local state of an {@link OsmPrimitive} with its state on the
      * server. The method uses an individual GET for the primitive.
-     *
+     * @param type the primitive type
      * @param id the primitive ID
      */
@@ -192 +192 @@
      * Handles the case that a conflict was detected while uploading where we don't
      * know what {@link OsmPrimitive} actually caused the conflict (for whatever reason)
-     *
+     * @param changesetId changeset ID
+     * @param d changeset date
      */
     protected void handleUploadConflictForClosedChangeset(long changesetId, Date d) {
@@ -211 +212 @@
      * Handles the case where deleting a node failed because it is still in use in
      * a non-deleted way on the server.
+     * @param e exception
+     * @param conflict conflict
      */
     protected void handleUploadPreconditionFailedConflict(OsmApiException e, Pair<OsmPrimitive, Collection<OsmPrimitive>> conflict) {

trunk/src/org/openstreetmap/josm/gui/io/LayerNameAndFilePathTableCell.java

@@ -121 +121 @@
     }
 
-    /** adds layer name label to (this) using the given info. Returns tooltip that
-     * should be added to the panel **/
+    /**
+     * Adds layer name label to (this) using the given info. Returns tooltip that should be added to the panel
+     * @param info information, user preferences and save/upload states of the layer
+     * @return tooltip that should be added to the panel
+     */
     private String addLblLayerName(SaveLayerInfo info) {
         lblLayerName.setIcon(info.getLayer().getIcon());
@@ -130 +133 @@
     }
 
-    /** adds filename label to (this) using the given info. Returns tooltip that
-     * should be added to the panel */
+    /**
+     * Adds filename label to (this) using the given info. Returns tooltip that should be added to the panel
+     * @param info information, user preferences and save/upload states of the layer
+     * @return tooltip that should be added to the panel
+     */
     private String addLblFilename(SaveLayerInfo info) {
         String tooltip = "";
@@ -157 +163 @@
     }
 
-    /** makes the given path fit lblFilename, appends ellipsis on the left if it doesn’t fit.
-     * Idea: /home/user/josm → …/user/josm → …/josm; and take the first one that fits */
+    /**
+     * Makes the given path fit lblFilename, appends ellipsis on the left if it doesn’t fit.
+     * Idea: /home/user/josm → …/user/josm → …/josm; and take the first one that fits
+     * @param t complete path
+     * @return shorter path
+     */
     private String makePathFit(String t) {
         boolean hasEllipsis = false;

trunk/src/org/openstreetmap/josm/gui/io/TagSettingsPanel.java

@@ -80 +80 @@
     }
 
+    /**
+     * Initialize panel from changeset.
+     * @param cs changeset
+     */
     public void initFromChangeset(Changeset cs) {
         Map<String, String> tags = getDefaultTags();
@@ -103 +107 @@
     /**
      * Replies the map with the current tags in the tag editor model.
-     *
+     * @param keepEmpty {@code true} to keep empty tags
      * @return the map with the current tags in the tag editor model.
      */
@@ -110 +114 @@
     }
 
+    /**
+     * Replies the map with the default tags.
+     * @return the map with the default tags
+     */
     public Map<String, String> getDefaultTags() {
         Map<String, String> tags = new HashMap<>();
@@ -116 +124 @@
     }
 
+    /**
+     * Sets the map with the default tags.
+     * @param tags the map with the default tags
+     */
     public void setDefaultTags(Map<String, String> tags) {
         defaultTags.clear();