Changeset 12284 in josm for trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java

Timestamp:

2017-05-31T15:50:05+02:00 (7 years ago)

Author:

Don-vip

Message:

see #14794 - javadoc

File:

• trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java

@@ -22 +22 @@
 
 /**
- * Helper for ParallelWayAction
+ * Helper for {@link ParallelWayAction}.
  *
  * @author Ole Jørgen Brønner (olejorgenb)
@@ -35 +35 @@
     private final EastNorth[] normals;
 
-    // Need a reference way to determine the direction of the offset when we manage multiple ways
+    /**
+     * Constructs a new {@code ParallelWays}.
+     * @param sourceWays source ways
+     * @param copyTags whether tags should be copied
+     * @param refWayIndex Need a reference way to determine the direction of the offset when we manage multiple ways
+     */
     public ParallelWays(Collection<Way> sourceWays, boolean copyTags, int refWayIndex) {
         // Possible/sensible to use PrimetiveDeepCopy here?
@@ -118 +123 @@
     }
 
+    /**
+     * Determines if the nodes graph form a closed path
+     * @return {@code true} if the nodes graph form a closed path
+     */
     public boolean isClosedPath() {
         return sortedNodes.get(0) == sortedNodes.get(sortedNodes.size() - 1);
@@ -169 +178 @@
     }
 
+    /**
+     * Performs the action by adding a new sequence command to the undo/redo queue.
+     */
     public void commit() {
-        SequenceCommand undoCommand = new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList());
-        Main.main.undoRedo.add(undoCommand);
+        Main.main.undoRedo.add(new SequenceCommand("Make parallel way(s)", makeAddWayAndNodesCommandList()));
     }
 
@@ -195 +206 @@
     }
 
+    /**
+     * Returns the resulting parallel ways.
+     * @return the resulting parallel ways
+     */
     public final List<Way> getWays() {
         return ways;