Changeset 12390 in josm for trunk/src/org/openstreetmap/josm/data/validation/OsmValidator.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/OsmValidator.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/validation/OsmValidator.java

@@ -134 +134 @@
     };
 
+    /**
+     * Adds a test to the list of available tests
+     * @param testClass The test class
+     */
     public static void addTest(Class<? extends Test> testClass) {
         allTests.add(testClass);
@@ -193 +197 @@
     }
 
+    /**
+     * Adds an ignored error
+     * @param s The ignore group / sub group name
+     * @see TestError#getIgnoreGroup()
+     * @see TestError#getIgnoreSubGroup()
+     */
     public static void addIgnoredError(String s) {
         ignoredErrors.add(s);
     }
 
+    /**
+     * Check if a error should be ignored
+     * @param s The ignore group / sub group name
+     * @return <code>true</code> to ignore that error
+     */
     public static boolean hasIgnoredError(String s) {
         return ignoredErrors.contains(s);
     }
 
+    /**
+     * Saves the names of the ignored errors to a file
+     */
     public static void saveIgnoredErrors() {
         try (PrintWriter out = new PrintWriter(new File(getValidatorDir(), "ignorederrors"), StandardCharsets.UTF_8.name())) {
@@ -270 +288 @@
     }
 
+    /**
+     * Gets all tests that are possible
+     * @return The tests
+     */
     public static Collection<Test> getTests() {
         return getAllTestsMap().values();
     }
 
+    /**
+     * Gets all tests that are run
+     * @param beforeUpload To get the ones that are run before upload
+     * @return The tests
+     */
     public static Collection<Test> getEnabledTests(boolean beforeUpload) {
         Collection<Test> enabledTests = getTests();