Changeset 9230 in josm for trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java

Timestamp:

2015-12-31T16:37:24+01:00 (8 years ago)

Author:

Don-vip

Message:

fix javadoc errors/warnings

File:

• trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java (modified) (7 diffs)

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

@@ -199 +199 @@
     /**
      * Collect groups of ways with common nodes in order to orthogonalize each group separately.
+     * @param wayDataList list of ways
      * @return groups of ways with common nodes
      */
@@ -246 +247 @@
      *      - The same for vertical segments.
      *  5. Rotate back.
+     * @param wayDataList list of ways
+     * @param headingNodes list of heading nodes
      * @return list of commands to perform
      * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
@@ -398 +401 @@
 
     /**
-     * Class contains everything we need to know about a singe way.
+     * Class contains everything we need to know about a single way.
      */
     private static class WayData {
@@ -477 +480 @@
     /**
      * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
+     * @param a angle
      * @return correct angle
      */
@@ -491 +495 @@
     /**
      * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
+     * @param a angle
      * @return correct angle
      */
@@ -513 +518 @@
         /**
          * Rotate counter-clock-wise.
+         * @param pivot pivot
+         * @param en original east/north
+         * @param angle angle, in radians
          * @return new east/north
          */
@@ -541 +549 @@
      * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
      * returns an integral value, corresponding to a counter clockwise turn.
+     * @param a angle, in radians
+     * @param deltaMax maximum tolerance, in radians
      * @return an integral value, corresponding to a counter clockwise turn
      * @throws RejectedAngleException in case of invalid angle