Changeset 11928 in josm for trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java

Timestamp:

2017-04-16T14:42:27+02:00 (9 years ago)

Author:

Don-vip

Message:

improve unit tests, javadoc

File:

• trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java

@@ -15 +15 @@
     private final boolean wasComplete;
 
+    /**
+     * Constructs a new {@code PrimitivesRemovedEvent}.
+     * @param dataSet the dataset from which the event comes from
+     * @param primitives the list of primitives affected by the change
+     * @param wasComplete {@code true} if primitive wasn't really removed from the dataset, it only become incomplete again
+     */
     public PrimitivesRemovedEvent(DataSet dataSet, Collection<? extends OsmPrimitive> primitives, boolean wasComplete) {
         super(dataSet);
@@ -32 +38 @@
 
     /**
-     *
-     * @return True if primitive wasn't really removed from the dataset, it only become incomplete again
+     * Determines if primitive wasn't really removed from the dataset, it only become incomplete again.
+     * @return {@code true} if primitive wasn't really removed from the dataset, it only become incomplete again
      */
     public boolean wasComplete() {