Changeset 8470 in josm for trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java

Timestamp:

2015-06-06T04:32:00+02:00 (9 years ago)

Author:

Don-vip

Message:

javadoc fixes. Removed one duplicated method in exception handling

File:

• trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java (modified) (8 diffs)

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

@@ -35 +35 @@
  *
  * The user can click on an object, which gets deleted if possible. When Ctrl is
- * pressed when releasing the button, the objects and all its references are
- * deleted.
+ * pressed when releasing the button, the objects and all its references are deleted.
  *
  * If the user did not press Ctrl and the object has any references, the user
@@ -47 +46 @@
  */
 public class DeleteAction extends MapMode implements ModifierListener {
-    // Cache previous mouse event (needed when only the modifier keys are
-    // pressed but the mouse isn't moved)
+    // Cache previous mouse event (needed when only the modifier keys are pressed but the mouse isn't moved)
     private MouseEvent oldEvent = null;
 
@@ -181 +179 @@
     /**
      * handles everything related to highlighting primitives and way
-     * segments for the given pointer position (via MouseEvent) and
-     * modifiers.
-     * @param e
-     * @param modifiers
+     * segments for the given pointer position (via MouseEvent) and modifiers.
+     * @param e current mouse event
+     * @param modifiers mouse modifiers, not necessarly taken from the given mouse event
      */
     private void addHighlighting(MouseEvent e, int modifiers) {
@@ -202 +199 @@
             Command delCmd = buildDeleteCommands(e, modifiers, true);
             if(delCmd != null) {
-                // all other cases delete OsmPrimitives directly, so we can
-                // safely do the following
+                // all other cases delete OsmPrimitives directly, so we can safely do the following
                 for(OsmPrimitive osm : delCmd.getParticipatingPrimitives()) {
                     newHighlights.add(osm);
@@ -236 +232 @@
 
     /**
-     * This function handles all work related to updating the cursor and
-     * highlights
+     * This function handles all work related to updating the cursor and highlights
      *
-     * @param e
-     * @param modifiers
+     * @param e current mouse event
+     * @param modifiers mouse modifiers, not necessarly taken from the given mouse event
      */
     private void updateCursor(MouseEvent e, int modifiers) {
@@ -260 +255 @@
      * mouse is not moved and only modifier keys are pressed, no mouse event
      * occurs. We can use AWTEvent to catch those but still lack a proper
-     * mouseevent. Instead we copy the previous event and only update the
-     * modifiers.
+     * mouseevent. Instead we copy the previous event and only update the modifiers.
      */
     private void giveUserFeedback(MouseEvent e, int modifiers) {
@@ -279 +273 @@
     /**
      * If user clicked with the left button, delete the nearest object.
-     * position.
      */
     @Override
@@ -372 +365 @@
      * @param e MouseEvent from which modifiers and position are taken
      * @param modifiers For explanation, see {@link #updateCursor}
-     * @param silent Set to true if the user should not be bugged with additional
-     *        dialogs
+     * @param silent Set to true if the user should not be bugged with additional dialogs
      * @return delete command
      */