add javadoc:

ucr-riple · Oct 3, 2024 · 2028025 · 2028025
1 parent 093f590
commit 2028025
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/annotator-core/src/main/java/edu/ucr/cs/riple/core/checkers/Checker.java b/annotator-core/src/main/java/edu/ucr/cs/riple/core/checkers/Checker.java
@@ -29,8 +29,6 @@
 import edu.ucr.cs.riple.core.module.ModuleConfiguration;
 import edu.ucr.cs.riple.core.module.ModuleInfo;
 import edu.ucr.cs.riple.core.registries.index.Error;
-import edu.ucr.cs.riple.core.registries.index.Fix;
-import edu.ucr.cs.riple.core.registries.region.Region;
 import java.util.Set;
 
 /**

diff --git a/annotator-core/src/main/java/edu/ucr/cs/riple/core/checkers/nullaway/NullAway.java b/annotator-core/src/main/java/edu/ucr/cs/riple/core/checkers/nullaway/NullAway.java
@@ -371,6 +371,19 @@ public void preprocess(AnnotationInjector injector) {
     injector.injectAnnotations(initializers);
   }
 
+  /**
+   * Creates a {@link NullAwayError} instance using the provided arguments. It also removes
+   * annotation change requests that are on an element with explict nonnull annotation.
+   *
+   * @param errorType Error Type from NullAway.
+   * @param errorMessage Error Message from NullAway.
+   * @param region Region where the error is reported.
+   * @param offset Offset of program point in the source file where the error is reported.
+   * @param resolvingFixes Resolving fixes that can fix the error if all applied to source code.
+   * @param module Module where this error is reported.
+   * @return Creates and returns the corresponding {@link NullAwayError} instance using the provided
+   *     information.
+   */
   private NullAwayError createError(
       String errorType,
       String errorMessage,