Changeset 5909 in josm for trunk/src/org/openstreetmap/josm/actions/mapmode

Timestamp:

2013-04-29T00:09:53+02:00 (11 years ago)

Author:

stoecker

Message:

fix all remaining javadoc warnings

Location:

trunk/src/org/openstreetmap/josm/actions/mapmode

Files:

• DeleteAction.java (modified) (1 diff)
• DrawAction.java (modified) (2 diffs)
• ImproveWayAccuracyHelper.java (modified) (3 diffs)
• SelectAction.java (modified) (3 diffs)

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

@@ -384 +384 @@
      * that should be deleted but does not actually delete them.
      * @param e MouseEvent from which modifiers and position are taken
-     * @param modifiers For explanation: @see updateCursor
-     * @param silet Set to true if the user should not be bugged with additional
+     * @param modifiers For explanation, see {@link #updateCursor}
+     * @param silent Set to true if the user should not be bugged with additional
      *        dialogs
-     * @return
+     * @return delete command
      */
     private Command buildDeleteCommands(MouseEvent e, int modifiers, boolean silent) {

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

@@ -684 +684 @@
 
     /**
-     * Prevent creation of ways that look like this: <---->
+     * Prevent creation of ways that look like this: &lt;----&gt;
      * This happens if users want to draw a no-exit-sideway from the main way like this:
      * ^
-     * |<---->
+     * |&lt;----&gt;
      * |
      * The solution isn't ideal because the main way will end in the side way, which is bad for
@@ -693 +693 @@
      * it on their own, too. At least it's better than producing an error.
      *
-     * @param Way the way to check
-     * @param Node the current node (i.e. the one the connection will be made from)
-     * @param Node the target node (i.e. the one the connection will be made to)
-     * @return Boolean True if this would create a selfcontaining way, false otherwise.
+     * @param selectedWay the way to check
+     * @param currentNode the current node (i.e. the one the connection will be made from)
+     * @param targetNode the target node (i.e. the one the connection will be made to)
+     * @return {@code true} if this would create a selfcontaining way, {@code false} otherwise.
      */
     private boolean isSelfContainedWay(Way selectedWay, Node currentNode, Node targetNode) {

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

@@ -28 +28 @@
      * the ways containing it. If the mouse is on the way, simply returns it.
      *
-     * @param mv
-     * @param p
-     * @return Way or null in case there is nothing under the cursor.
+     * @param mv the current map view
+     * @param p the cursor position
+     * @return {@code Way} or {@code null} in case there is nothing under the cursor.
      */
     public static Way findWay(MapView mv, Point p) {
@@ -64 +64 @@
      * candidateNode to a new place.
      *
-     * @param mv
-     * @param w
-     * @param p
-     * @return
+     * @param mv the current map view
+     * @param w the way to check
+     * @param p the cursor position
+     * @return nearest node to cursor
      */
     public static Node findCandidateNode(MapView mv, Way w, Point p) {
@@ -114 +114 @@
      * with the largest angle apb is chosen.
      *
-     * @param mv
-     * @param w
-     * @param p
-     * @return
+     * @param mv the current map view
+     * @param w the way to check
+     * @param p the cursor position
+     * @return nearest way segment to cursor
      */
     public static WaySegment findCandidateSegment(MapView mv, Way w, Point p) {

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

@@ -228 +228 @@
      * handles adding highlights and updating the cursor for the given mouse event.
      * Please note that the highlighting for merging while moving is handled via mouseDragged.
-     * @param MouseEvent which should be used as base for the feedback
-     * @return true if repaint is required
+     * @param e {@code MouseEvent} which should be used as base for the feedback
+     * @return {@code true} if repaint is required
      */
     private boolean giveUserFeedback(MouseEvent e) {
@@ -238 +238 @@
      * handles adding highlights and updating the cursor for the given mouse event.
      * Please note that the highlighting for merging while moving is handled via mouseDragged.
-     * @param MouseEvent which should be used as base for the feedback
-     * @param define custom keyboard modifiers if the ones from MouseEvent are outdated or similar
-     * @return true if repaint is required
+     * @param e {@code MouseEvent} which should be used as base for the feedback
+     * @param modifiers define custom keyboard modifiers if the ones from MouseEvent are outdated or similar
+     * @return {@code true} if repaint is required
      */
     private boolean giveUserFeedback(MouseEvent e, int modifiers) {
@@ -1058 +1058 @@
          * <code>virtualWays</code>.
          *
-         * @param e contains the point clicked
+         * @param p the point clicked
          * @return whether
          * <code>virtualNode</code> and