Changeset 5275 in josm for trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java

Timestamp:

2012-06-09T20:03:41+02:00 (12 years ago)

Author:

bastiK

Message:

doc improvements

File:

• trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java

@@ -1 +1 @@
 // License: GPL. Copyright 2007 by Immanuel Scholz and others
-// Author: David Earl
 package org.openstreetmap.josm.actions;
 
@@ -29 +28 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * Action, to paste all tags from one primitive to another.
+ *
+ * It will take the primitive from the copy-paste buffer an apply all its tags
+ * to the selected primitive(s).
+ *
+ * @author David Earl
+ */
 public final class PasteTagsAction extends JosmAction implements PasteBufferChangedListener {
 
@@ -54 +61 @@
          * Replies true if the source for tag pasting is heterogeneous, i.e. if it doesn't consist of
          * {@link OsmPrimitive}s of exactly one type
-         *
-         * @return
          */
         protected boolean isHeteogeneousSource() {
@@ -130 +135 @@
 
         /**
-         * Pastes the tags from a homogeneous source (i.e. the {@link Main#pasteBuffer}s selection consisting
-         * of one type of {@link OsmPrimitive}s only.
+         * Pastes the tags from a homogeneous source (the {@link Main#pasteBuffer}s selection consisting
+         * of one type of {@link OsmPrimitive}s only).
          *
          * Tags from a homogeneous source can be pasted to a heterogeneous target. All target primitives,
          * regardless of their type, receive the same tags.
-         *
-         * @param targets the collection of target primitives
          */
         protected void pasteFromHomogeneousSource() {
@@ -166 +169 @@
 
         /**
-         * Replies true if there is at least one primitive of type <code>type</code> in the collection
-         * <code>selection</code>
-         *
-         * @param <T>
-         * @param selection  the collection of primitives
+         * Replies true if there is at least one primitive of type <code>type</code> 
+         * is in the target collection
+         *
+         * @param <T>
          * @param type  the type to look for
          * @return true if there is at least one primitive of type <code>type</code> in the collection
@@ -199 +201 @@
          * Pastes the tags in the current selection of the paste buffer to a set of target
          * primitives.
-         *
-         * @param targets the collection of target primitives
          */
         protected void pasteFromHeterogeneousSource() {