Changeset 12210 in josm

Timestamp:

2017-05-18T23:05:39+02:00 (8 years ago)

Author:

michael2402

Message:

Documentation of ReverseWayAction

File:

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

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

@@ -29 +29 @@
 import org.openstreetmap.josm.tools.UserCancelException;
 
+/**
+ * Reverses the ways that are currently selected by the user
+ */
 public final class ReverseWayAction extends JosmAction {
 
+    /**
+     * The resulting way after reversing it and the commands to get there.
+     */
     public static class ReverseWayResult {
         private final Way newWay;
@@ -36 +42 @@
         private final Command reverseCommand;
 
+        /**
+         * Create a new {@link ReverseWayResult}
+         * @param newWay The new way primitive
+         * @param tagCorrectionCommands The commands to correct the tags
+         * @param reverseCommand The command to reverse the way
+         */
         public ReverseWayResult(Way newWay, Collection<Command> tagCorrectionCommands, Command reverseCommand) {
             this.newWay = newWay;
@@ -42 +54 @@
         }
 
+        /**
+         * Gets the new way object
+         * @return The new, reversed way
+         */
         public Way getNewWay() {
             return newWay;
         }
 
+        /**
+         * Gets the commands that will be required to do a full way reversal including changing the tags
+         * @return The comamnds
+         */
         public Collection<Command> getCommands() {
             List<Command> c = new ArrayList<>();
@@ -53 +73 @@
         }
 
+        /**
+         * Gets a single sequence command for reversing this way including changing the tags
+         * @return the command
+         */
         public Command getAsSequenceCommand() {
             return new SequenceCommand(tr("Reverse way"), getCommands());
         }
 
+        /**
+         * Gets the basic reverse command that only changes the order of the nodes.
+         * @return The reorder nodes command
+         */
         public Command getReverseCommand() {
             return reverseCommand;
         }
 
+        /**
+         * Gets the command to change the tags of the way
+         * @return The command to reverse the tags
+         */
         public Collection<Command> getTagCorrectionCommands() {
             return tagCorrectionCommands;
@@ -66 +98 @@
     }
 
+    /**
+     * Creates a new {@link ReverseWayAction} and binds the shortcut
+     */
     public ReverseWayAction() {
         super(tr("Reverse Ways"), "wayflip", tr("Reverse the direction of all selected ways."),