Changeset 12390 in josm for trunk/src/org/openstreetmap/josm/data/validation/tests/SimilarNamedWays.java

Timestamp:

2017-06-11T13:39:33+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: Document data.validation package and subpackages.

File:

• trunk/src/org/openstreetmap/josm/data/validation/tests/SimilarNamedWays.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/validation/tests/SimilarNamedWays.java

@@ -235 +235 @@
     }
 
+    /**
+     * A normalization that is applied to names before testing them
+     */
     @FunctionalInterface
     public interface NormalizeRule {
@@ -246 +249 @@
     }
 
+    /**
+     * A rule to replace by regular expression,
+     * so that all strings matching the regular expression are handled as if they were {@link RegExprRule#replacement}
+     */
     public static class RegExprRule implements NormalizeRule {
         private final Pattern regExpr;
         private final String replacement;
 
+        /**
+         * Create a new rule to replace by regular expression
+         * @param expression The regular expression
+         * @param replacement The replacement
+         */
         public RegExprRule(String expression, String replacement) {
             this.regExpr = Pattern.compile(expression);
@@ -266 +278 @@
     }
 
+    /**
+     * A rule that registers synonyms to a given word
+     */
     public static class SynonymRule implements NormalizeRule {
 
@@ -272 +287 @@
         private final String replacement;
 
+        /**
+         * Create a new {@link SynonymRule}
+         * @param replacement The word to use instead
+         * @param words The synonyms for that word
+         */
         public SynonymRule(String replacement, String... words) {
             this.replacement = replacement.toLowerCase(Locale.ENGLISH);