Changeset 8900 in josm for trunk/src/org/openstreetmap/josm/actions/AutoScaleAction.java

Timestamp:

2015-10-18T23:16:54+02:00 (11 years ago)

Author:

Don-vip

Message:

fix #11986, fix #11987, fix #11988: Patches by michael2402:

• MapStatus: Use a BlockingQueue for cleaner waiting
• Comment in AutoScaleAction#zoomTo is wrong
• Documentation for AutoScaleAction

File:

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

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

@@ -43 +43 @@
 public class AutoScaleAction extends JosmAction {
 
+    /**
+     * A list of things we can zoom to. The zoom target is given depending on the mode.
+     */
     public static final Collection<String> MODES = Collections.unmodifiableList(Arrays.asList(
         marktr(/* ICON(dialogs/autoscale/) */ "data"),
@@ -53 +56 @@
         marktr(/* ICON(dialogs/autoscale/) */ "next")));
 
+    /**
+     * One of {@link #MODES}. Defines what we are zooming to.
+     */
     private final String mode;
 
@@ -83 +89 @@
     }
 
+    /**
+     * Zooms the view to display the given set of primitives.
+     * @param sel The primitives to zoom to, e.g. the current selection.
+     */
     public static void zoomTo(Collection<OsmPrimitive> sel) {
         BoundingXYVisitor bboxCalculator = new BoundingXYVisitor();
         bboxCalculator.computeBoundingBox(sel);
-        // increase bbox by 0.001 degrees on each side. this is required
+        // increase bbox. This is required
         // especially if the bbox contains one single node, but helpful
         // in most other cases as well.
@@ -95 +105 @@
     }
 
+    /**
+     * Performs the auto scale operation of the given mode without the need to create a new action.
+     * @param mode One of {@link #MODES}.
+     */
     public static void autoScale(String mode) {
         new AutoScaleAction(mode, false).autoScale();
@@ -172 +186 @@
     }
 
+    /**
+     * Performs this auto scale operation for the mode this action is in.
+     */
     public void autoScale() {
         if (Main.isDisplayingMapView()) {