added test to find no errors with code in javadoc comment

Author: Maillman

src/test/java/edu/byu/cs240/checkstyle/readability/CommentedCodeTest.java

@@ -61,6 +61,14 @@ public void should_FindNoErrors_when_commentInString() throws CheckstyleExceptio
     }
 
 
+    @Test
+    @DisplayName("Should find no errors in code that has javadoc comment")
+    public void should_FindNoErrors_when_javadocComment() throws CheckstyleException {
+        String fileName = "testInputs/commentedCode/should_FindNoErrors_when_javadocComment.java";
+        testFiles(0, fileName);
+    }
+
+
     @Test
     @DisplayName("Should find errors in code that has code comments")
     public void should_FindErrors_when_CodeComments() throws CheckstyleException {

src/test/resources/edu/byu/cs240/checkstyle/readability/testInputs/commentedCode/should_FindNoErrors_when_javadocComment.java

@@ -0,0 +1,69 @@
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Stream;
+
+class should_FindNoErrors_when_javadocComment {
+    /**
+     * Receives a path to a file/directory and maps all file names the associated absolute paths.
+     * <br>
+     * If the path provided leads to a directory, all the files in the directory are returned as a
+     * mapping of their file names to their absolute paths. If the path provided leads not to a directory,
+     * only the mapping of its file name and absolute path is returned.
+     * <br><br><br>
+     * For a <b>file</b> example, given the input of
+     * {@code "autograder/phases/phase0/passoff/chess/ChessBoardTests.java"},
+     * we get an output of:
+     * <br>
+     * <code>
+     * {
+     *     "ChessBoardTests.java": "autograder/phases/phase0/passoff/chess/ChessBoardTests.java"
+     * }
+     * </code>
+     * <br><br>
+     * For a <b>directory</b> example, given the input of
+     * {@code "autograder/phases/phase0/passoff/chess/"},
+     * we get an output of:
+     * <br>
+     * <code>
+     * {
+     *     "QueenMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/QueenMoveTests.java",
+     *     "EqualsTestingUtility.java": "autograder/phases/phase0/passoff/chess/EqualsTestingUtility.java",
+     *     "ChessPositionTests.java": "autograder/phases/phase0/passoff/chess/ChessPositionTests.java",
+     *     "TestUtilities.java": "autograder/phases/phase0/passoff/chess/TestUtilities.java",
+     *     "ChessMoveTests.java": "autograder/phases/phase0/passoff/chess/ChessMoveTests.java",
+     *     "ChessPieceTests.java": "autograder/phases/phase0/passoff/chess/ChessPieceTests.java",
+     *     "KnightMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/KnightMoveTests.java",
+     *     "ChessBoardTests.java": "autograder/phases/phase0/passoff/chess/ChessBoardTests.java",
+     *     "RookMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/RookMoveTests.java",
+     *     "BishopMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/BishopMoveTests.java",
+     *     "KingMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/KingMoveTests.java",
+     *     "PawnMoveTests.java": "autograder/phases/phase0/passoff/chess/piecemoves/PawnMoveTests.java"
+     * }
+     * </code>
+     *
+     * @param filePath The path to file/directory to find all the file names and the associated absolute paths
+     * @return A map of the file names and the associated absolute paths given a path
+     */
+    public static Map<String, String> getFileNamesToAbsolutePaths(Path filePath) throws GradingException {
+        Map<String, String> fileNamesToAbsolutesPaths = new HashMap<>();
+        try (Stream<Path> paths = Files.walk(filePath)) {
+            for (Path path : paths.toList()) {
+                File file = path.toFile();
+                if (file.isFile()) {
+                    String fileName = file.getName();
+                    String absolutePath = file.getAbsolutePath();
+                    fileNamesToAbsolutesPaths.put(fileName, absolutePath);
+                }
+            }
+        } catch (IOException e) {
+            throw new GradingException(
+                    String.format("Could not find file names given %s: %s", filePath, e.getMessage())
+            );
+        }
+        return fileNamesToAbsolutesPaths;
+    }
+}