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

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

@@ -299 +299 @@
     }
 
+    /**
+     * Gets the ignores subgroup that is more specialized than {@link #getIgnoreGroup()}
+     * @return The ignore sub group
+     */
     public String getIgnoreSubGroup() {
         String ignorestring = getIgnoreGroup();
@@ -307 +311 @@
     }
 
+    /**
+     * Gets the ignore group ID that is used to allow the user to ignore all same errors
+     * @return The group id
+     * @see TestError#getIgnoreSubGroup()
+     */
     public String getIgnoreGroup() {
         return Integer.toString(code);
     }
 
+    /**
+     * Flags this error as ignored
+     * @param state The ignore flag
+     */
     public void setIgnored(boolean state) {
         ignored = state;
     }
 
+    /**
+     * Checks if this error is ignored
+     * @return <code>true</code> if it is ignored
+     */
     public boolean isIgnored() {
         return ignored;
@@ -371 +388 @@
     }
 
+    /**
+     * Visits all highlighted validation elements
+     * @param v The visitor that should receive a visit-notification on all highlighted elements
+     */
     @SuppressWarnings("unchecked")
     public void visitHighlighted(ValidatorVisitor v) {