Update Javadocs

Author: rcosta358

liquidjava-verifier/src/test/java/liquidjava/api/tests/TestExamples.java

@@ -27,11 +27,7 @@ public class TestExamples {
     Diagnostics diagnostics = Diagnostics.getInstance();
 
     /**
-     * Test the file at the given path by launching the verifier and checking for errors and warnings. The
-     * file/directory is expected to be either correct, contain an error, or report warnings based on its name.
-     *
-     * @param path
-     *            path to the file to test
+     * Runs the verifier and checks the expected diagnostics
      */
     @ParameterizedTest
     @MethodSource("sourcePaths")
@@ -72,6 +68,9 @@ else if (shouldFail(pathName)) {
         }
     }
 
+    /**
+     * Checks that the found diagnostics match the expected diagnostics
+     */
     private static void checkExpectedDiagnostics(String pathName, Collection<? extends LJDiagnostic> found,
             List<Pair<String, Integer>> expected, String output) {
         if (found.size() != expected.size()) {
@@ -102,13 +101,7 @@ private static boolean matches(LJDiagnostic diagnostic, Pair<String, Integer> ex
     }
 
     /**
-     * Returns a Stream of paths to test files in the testSuite directory. These include files with names starting with
-     * "Correct" or "Error", and directories containing "correct" or "error". §
-     * 
-     * @return Stream of paths to test files
-     *
-     * @throws IOException
-     *             if an I/O error occurs or the path does not exist
+     * Returns the test suite paths to verify
      */
     private static Stream<Path> sourcePaths() throws IOException {
         return Files.find(Paths.get("../liquidjava-example/src/main/java/testSuite/"), Integer.MAX_VALUE,
@@ -128,8 +121,7 @@ private static Stream<Path> sourcePaths() throws IOException {
     }
 
     /**
-     * Test multiple paths at once, including both files and directories. This test ensures that the verifier can handle
-     * multiple inputs correctly and that no errors are found in files/directories that are expected to be correct.
+     * Verifies that multiple correct inputs can be processed together
      */
     @Test
     public void testMultiplePaths() {

liquidjava-verifier/src/test/java/liquidjava/utils/TestUtils.java

@@ -16,47 +16,22 @@
 
 public class TestUtils {
 
-    private static final Pattern EXPECTED_DIAGNOSTIC = Pattern.compile("//\\s*(.*?\\b(Error|Warning)\\b)",
-            Pattern.CASE_INSENSITIVE);
+    private static final Pattern EXPECTED_DIAGNOSTIC = Pattern.compile("//\\s*(.*?\\b(Error|Warning)\\b)", Pattern.CASE_INSENSITIVE);
     private final static Factory factory = new Launcher().getFactory();
     private final static Context context = Context.getInstance();
 
-    /**
-     * Determines if the given path indicates that the test should pass
-     * 
-     * @param path
-     */
     public static boolean shouldPass(String path) {
         return path.toLowerCase().contains("correct");
     }
 
-    /**
-     * Determines if the given path indicates that the test should fail
-     * 
-     * @param path
-     */
     public static boolean shouldFail(String path) {
         return path.toLowerCase().contains("error");
     }
 
-    /**
-     * Determines if the given path indicates that the test should report warnings
-     *
-     * @param path
-     */
     public static boolean shouldWarn(String path) {
         return path.toLowerCase().contains("warning");
     }
 
-    /**
-     * Reads the expected error messages from the given file by looking for a comment containing the expected error
-     * message.
-     * 
-     * @param filePath
-     * 
-     * @return list of expected error messages found in the file, or empty list if there was an error reading the file
-     *         or if there are no expected error messages in the file
-     */
     public static List<Pair<String, Integer>> getExpectedErrorsFromFile(Path filePath) {
         return getExpectedDiagnosticsFromFile(filePath, "error");
     }
@@ -79,39 +54,14 @@ private static List<Pair<String, Integer>> getExpectedDiagnosticsFromFile(Path f
         return expectedDiagnostics;
     }
 
-    /**
-     * Reads the expected warning messages from the given file by looking for a comment containing the expected warning
-     * message.
-     *
-     * @param filePath
-     *
-     * @return list of expected warning messages found in the file, or empty list if there was an error reading the file
-     *         or if there are no expected warning messages in the file
-     */
     public static List<Pair<String, Integer>> getExpectedWarningsFromFile(Path filePath) {
         return getExpectedDiagnosticsFromFile(filePath, "warning");
     }
 
-    /**
-     * Reads the expected error messages from all files in the given directory and combines them into a single list
-     * 
-     * @param dirPath
-     * 
-     * @return list of expected error messages from all files in the directory, or empty list if there was an error
-     *         reading the directory or if there are no files in the directory
-     */
     public static List<Pair<String, Integer>> getExpectedErrorsFromDirectory(Path dirPath) {
         return getExpectedDiagnosticsFromDirectory(dirPath, "error");
     }
 
-    /**
-     * Reads the expected warning messages from all files in the given directory and combines them into a single list.
-     *
-     * @param dirPath
-     *
-     * @return list of expected warning messages from all files in the directory, or empty list if there was an error
-     *         reading the directory or if there are no files in the directory
-     */
     public static List<Pair<String, Integer>> getExpectedWarningsFromDirectory(Path dirPath) {
         return getExpectedDiagnosticsFromDirectory(dirPath, "warning");
     }
@@ -129,11 +79,7 @@ private static List<Pair<String, Integer>> getExpectedDiagnosticsFromDirectory(P
         return expectedDiagnostics;
     }
 
-    /**
-     * Helper method to add an integer variable to the context
-     */
     public static void addIntVariableToContext(String name) {
-        context.addVarToContext(name, factory.Type().INTEGER_PRIMITIVE, new Predicate(),
-                factory.Code().createCodeSnippetStatement(""));
+        context.addVarToContext(name, factory.Type().INTEGER_PRIMITIVE, new Predicate(), factory.Code().createCodeSnippetStatement(""));
     }
 }