Ticket #22832: josm_22832_typo_documentation_fixes.patch

src/org/openstreetmap/josm/actions/upload/UploadHook.java

@@ -6 +6 @@
 import org.openstreetmap.josm.data.APIDataSet;
 
 /**
- * Change, or block, the upload.
+ * Change or block the upload.
  *
  * The UploadHook may modify the uploaded data silently, it may display a
  * warning message to the user or prevent the upload altogether.
@@ -16 +16 @@
 public interface UploadHook {
 
     /**
-     * Check, and/or change, the data to be uploaded.
+     * Check and/or change the data to be uploaded.
      * Default implementation is to approve the upload.
      * @param apiDataSet the data to upload, modify this to change the data.
      * @return {@code true} if upload is possible, {@code false} to block the upload.

src/org/openstreetmap/josm/actions/UploadAction.java

@@ -56 +56 @@
      * when the user wants to upload data. Plugins can insert their own hooks here
      * if they want to be able to veto an upload.
      *
-     * Be default, the standard upload dialog is the only element in the list.
+     * By default, the standard upload dialog is the only element in the list.
      * Plugins should normally insert their code before that, so that the upload
      * dialog is the last thing shown before upload really starts; on occasion
      * however, a plugin might also want to insert something after that.
@@ -214 +214 @@
                 return false;
             }
         }
+
         // Call all upload hooks in sequence.
         // FIXME: this should become an asynchronous task
-        //
         if (apiData != null) {
             return UPLOAD_HOOKS.stream().allMatch(hook -> hook.checkUpload(apiData));
         }
@@ -283 +283 @@
             Optional<AsynchronousUploadPrimitivesTask> asyncUploadTask = AsynchronousUploadPrimitivesTask.createAsynchronousUploadTask(
                     uploadStrategySpecification, layer, apiData, cs);
 
-            if (asyncUploadTask.isPresent()) {
-                MainApplication.worker.execute(asyncUploadTask.get());
-            }
+            asyncUploadTask.ifPresent(MainApplication.worker::execute);
         } else {
             MainApplication.worker.execute(new UploadPrimitivesTask(uploadStrategySpecification, layer, apiData, cs));
         }

src/org/openstreetmap/josm/data/osm/IPrimitive.java

@@ -287 +287 @@
      * used to check against edit conflicts.
      *
      * @return date of last modification
-     * @see #getInstant
+     * @see #setInstant
      */
     Instant getInstant();
 

src/org/openstreetmap/josm/data/osm/OsmUtils.java

@@ -118 +118 @@
     /**
      * Check if a tag value represents a boolean false value
      * @param value The value to check
-     * @return true if it is a true value.
+     * @return true if it is a false value.
      */
     public static boolean isFalse(String value) {
         if (value == null) {
@@ -137 +137 @@
 
     /**
      * Creates a new OSM primitive around (0,0) according to the given assertion. Originally written for unit tests,
-     * this can also be used in another places like validation of local MapCSS validator rules.
+     * this can also be used in other places like validation of local MapCSS validator rules.
      * Ways and relations created using this method are empty.
      * @param assertion The assertion describing OSM primitive (ex: "way name=Foo railway=rail")
      * @return a new OSM primitive according to the given assertion
@@ -150 +150 @@
 
     /**
      * Creates a new OSM primitive according to the given assertion. Originally written for unit tests,
-     * this can also be used in another places like validation of local MapCSS validator rules.
+     * this can also be used in other places like validation of local MapCSS validator rules.
      * @param assertion The assertion describing OSM primitive (ex: "way name=Foo railway=rail")
      * @param around the coordinate at which the primitive will be located
      * @param enforceLocation if {@code true}, ways and relations will not be empty to force a physical location

src/org/openstreetmap/josm/data/osm/Storage.java

@@ -14 +14 @@
 import org.openstreetmap.josm.tools.Utils;
 
 /**
- * A Set-like class that allows looking up equivalent preexising instance.
+ * A Set-like class that allows looking up equivalent preexisting instance.
  * It is useful wherever one would use self-mapping construct like
  * <code>Map&lt;T,T&gt;.put(t,t)</code>, that is, for caches, uniqueness filters or similar.
  *

src/org/openstreetmap/josm/data/projection/Ellipsoid.java

@@ -356 +356 @@
     public double latitude(double latIso, double e, double epsilon) {
         double lat0 = 2*Math.atan(Math.exp(latIso))-Math.PI/2;
         double lati = lat0;
-        double lati1 = 1.0; // random value to start the iterative processus
+        double lati1 = 1.0; // random value to start the iterative processes
         while (Math.abs(lati1-lati) >= epsilon) {
             lati = lati1;
             double v1 = 1+e*Math.sin(lati);

src/org/openstreetmap/josm/data/validation/routines/EmailValidator.java

@@ -29 +29 @@
  * </p>
  * <p>
  * This implementation is not guaranteed to catch all possible errors in an email address.
- * </p>.
  *
  * @version $Revision: 1741724 $
  * @since Validator 1.4
@@ -125 +124 @@
     }
 
     /**
-     * <p>Checks if a field has a valid e-mail address.</p>
+     * Checks if a field has a valid e-mail address.
      *
-     * @param email The value validation is being performed on.  A <code>null</code>
+     * @param email The value validation is being performed on. A <code>null</code>
      *              value is considered invalid.
      * @return true if the email address is valid.
      */

src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMergeModel.java

@@ -634 +634 @@
          * replies true if the {@link ListRole} of this {@link EntriesTableModel}
          * participates in the current {@link ComparePairType}
          *
-         * @return true, if the if the {@link ListRole} of this {@link EntriesTableModel}
+         * @return true, if the {@link ListRole} of this {@link EntriesTableModel}
          * participates in the current {@link ComparePairType}
          *
          * @see AbstractListMergeModel.ComparePairListModel#getSelectedComparePair()

src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMerger.java

@@ -774 +774 @@
         }
 
         /**
-         * Java 1.5 doesn't known Action.SELECT_KEY. Wires a toggle button to this action
+         * Java 1.5 doesn't know Action.SELECT_KEY. Wires a toggle button to this action
          * such that the action gets notified about item state changes and the button gets
          * notified about selection state changes of the action.
          *

src/org/openstreetmap/josm/gui/dialogs/properties/PropertiesDialog.java

@@ -135 +135 @@
  *
  * If no object is selected, the dialog list is empty.
  * If only one is selected, all tags of this object are selected.
- * If more than one object are selected, the sum of all tags are displayed. If the
+ * If more than one object is selected, the sum of all tags is displayed. If the
  * different objects share the same tag, the shared value is displayed. If they have
  * different values, all of them are put in a combo box and the string "<different>"
  * is displayed in italic.

src/org/openstreetmap/josm/gui/layer/MainLayerManager.java

@@ -26 +26 @@
  * <p>
  * The active layer is the layer the user is currently working on.
  * <p>
- * The edit layer is an data layer that we currently work with.
+ * The edit layer is a data layer that we currently work with.
  * @author Michael Zangl
  * @since 10279
  */
@@ -210 +210 @@
     }
 
     /**
-     * Adds a active/edit layer change listener. Fire a fake active-layer-changed-event right after adding
+     * Adds an active/edit layer change listener. Fire a fake active-layer-changed-event right after adding
      * the listener. The previous layers will be null. The listener is notified in the current thread.
      * @param listener the listener.
      */

src/org/openstreetmap/josm/gui/progress/swing/PleaseWaitProgressMonitor.java

@@ -106 +106 @@
     }
 
     private void doInEDT(Runnable runnable) {
-        // This must be invoke later even if current thread is EDT because inside there is dialog.setVisible
+        // This must be invoked later even if current thread is EDT because inside there is dialog.setVisible
         // which freeze current code flow until modal dialog is closed
         SwingUtilities.invokeLater(() -> {
             try {

src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java

@@ -75 +75 @@
     void finishTask();
 
     /**
-     * Can be used if method receive ProgressMonitor but it's not interested progress monitoring.
+     * Can be used if method receives ProgressMonitor, but it's not interested progress monitoring.
      * Basically replaces {@link #beginTask(String)} and {@link #finishTask()}
      *
-     * This method can be also used in finally section if method expects that some exception
+     * This method can be also used in finally section if method expects that some exceptions
      * might prevent it from passing progressMonitor away. If {@link #beginTask(String)} was
      * already called then this method does nothing.
      */

src/org/openstreetmap/josm/gui/widgets/AbstractFileChooser.java

@@ -97 +97 @@
      * as an available choice in the choosable filter list.
      * If false, the <code>AcceptAll</code> file filter is removed from
      * the list of available file filters.
-     * If true, the <code>AcceptAll</code> file filter will become the
+     * If true, the <code>AcceptAll</code> file filter will become
      * the actively used file filter.
      * @param b whether the <code>AcceptAll FileFilter</code> is used
      * as an available choice in the choosable filter list

src/org/openstreetmap/josm/gui/MainApplication.java

@@ -683 +683 @@
                 "\t--version                                 "+tr("Displays the JOSM version and exits")+"\n\n"+
                 "\t--status-report                           "+ShowStatusReportAction.ACTION_DESCRIPTION+"\n\n"+
                 "\t--debug                                   "+tr("Print debugging messages to console")+"\n\n"+
+                "\t--trace                                   "+tr("Print detailed debugging messages to console")+"\n\n"+
                 "\t--skip-plugins                            "+tr("Skip loading plugins")+"\n\n"+
                 "\t--offline=" + Arrays.stream(OnlineResource.values()).map(OnlineResource::name).collect(
                         Collectors.joining("|", "<", ">")) + "\n" +
@@ -992 +993 @@
         ChangesetUpdater.start();
 
         if (Config.getPref().getBoolean("debug.edt-checker.enable", Version.getInstance().isLocalBuild())) {
-            // Repaint manager is registered so late for a reason - there is lots of violation during startup process
+            // Repaint manager is registered so late for a reason - there are lots of violations during startup process
             // but they don't seem to break anything and are difficult to fix
             Logging.info("Enabled EDT checker, wrongful access to gui from non EDT thread will be printed to console");
             RepaintManager.setCurrentManager(new CheckThreadViolationRepaintManager());
@@ -1180 +1181 @@
         UIManager.put("OptionPane.yesIcon", UIManager.get("OptionPane.okIcon"));
         UIManager.put("OptionPane.cancelIcon", ImageProvider.getIfAvailable("cancel"));
         UIManager.put("OptionPane.noIcon", UIManager.get("OptionPane.cancelIcon"));
-        // Ensures caret color is the same than text foreground color, see #12257
+        // Ensures caret color is the same as text foreground color, see #12257
         // See https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/synth/doc-files/componentProperties.html
         for (String p : Arrays.asList(
                 "EditorPane", "FormattedTextField", "PasswordField", "TextArea", "TextField", "TextPane")) {

src/org/openstreetmap/josm/tools/Geometry.java

@@ -350 +350 @@
     }
 
     /**
-     * Get the segment segment intersection of two line segments
+     * Get the segment-segment intersection of two line segments
      * @param x1 The x coordinate of the first point (first segment)
      * @param y1 The y coordinate of the first point (first segment)
      * @param x2 The x coordinate of the second point (first segment)
@@ -921 +921 @@
     }
 
     /**
-     * Get angles in radians and return it's value in range [0, 180].
+     * Get angles in radians and return its value in range [0, 180].
      *
      * @param angle the angle in radians
      * @return normalized angle in degrees
@@ -992 +992 @@
     }
 
     /**
-     * Compute center of the circle closest to different nodes.
+     * Compute the center of the circle closest to different nodes.
      *
      * Ensure exact center computation in case nodes are already aligned in circle.
      * This is done by least square method.

src/org/openstreetmap/josm/tools/GuiSizesHelper.java

@@ -10 +10 @@
 /**
  * Support class to handle size information of Gui elements
  * This is needed, because display resolution may vary a lot and a common set
- * of sizes wont work for all users alike.
+ * of sizes won't work for all users alike.
  * @since 12682 (moved from {@code gui.util} package)
  * @since 10358
  */

src/org/openstreetmap/josm/tools/HttpClient.java

@@ -35 +35 @@
 import org.openstreetmap.josm.spi.preferences.Config;
 
 /**
- * Provides a uniform access for a HTTP/HTTPS server. This class should be used in favour of {@link HttpURLConnection}.
+ * Provides uniform access for a HTTP/HTTPS server. This class should be used in favour of {@link HttpURLConnection}.
  * @since 9168
  */
 public abstract class HttpClient {

test/unit/org/openstreetmap/josm/data/validation/tests/DirectionNodesTest.java

@@ -9 +9 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
 /**
- * JUnit Test of Multipolygon validation test.
+ * JUnit Test of {@link DirectionNodes} validation test.
  */
 class DirectionNodesTest {
 
-
     /**
      * Setup test.
      */
@@ -26 +25 @@
      * @throws Exception in case of error
      */
     @Test
-    void testDirectionsNodesTestFile() throws Exception {
+    void testDirectionNodesTestFile() throws Exception {
         final DirectionNodes test = new DirectionNodes();
         ValidatorTestUtils.testSampleFile("nodist/data/direction-nodes.osm", DataSet::getNodes, null, test);
     }

test/unit/org/openstreetmap/josm/data/validation/tests/SelfIntersectingWayTest.java

@@ -22 +22 @@
 import org.openstreetmap.josm.data.osm.Way;
 
 /**
- * JUnit Test of Multipolygon validation test.
+ * JUnit Test of SelfIntersectingWay validation test.
  */
 class SelfIntersectingWayTest {