Handle javadoc markdown comments

Follow-up to 2dde254 Code not deliberately using the new feature may contain line comments that start with `///`, which are now parsed as the new style of markdown comments. PiperOrigin-RevId: 641905816
google · Jun 10, 2024 · 4c06673 · 4c06673
1 parent 5f4024a
commit 4c06673
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/check_api/src/main/java/com/google/errorprone/util/Comments.java b/check_api/src/main/java/com/google/errorprone/util/Comments.java
@@ -96,9 +96,10 @@ public static String getTextFromComment(ErrorProneComment comment) {
         return comment.getText().replaceAll("^\\s*/\\*\\s*(.*?)\\s*\\*/\\s*", "$1");
       case LINE:
         return comment.getText().replaceAll("^\\s*//\\s*", "");
+      case JAVADOC_LINE:
+        return comment.getText().replaceAll("^\\s*///\\s*", "");
       case JAVADOC_BLOCK:
         return comment.getText().replaceAll("^\\s*/\\*\\*\\s*(.*?)\\s*\\*/\\s*", "$1");
-      default:
     }
     throw new AssertionError(comment.getStyle());
   }

diff --git a/core/src/test/java/com/google/errorprone/bugpatterns/ParameterCommentTest.java b/core/src/test/java/com/google/errorprone/bugpatterns/ParameterCommentTest.java
@@ -254,4 +254,21 @@ public void matchingCommentsAfterwards() {
             "}")
         .doTest();
   }
+
+  @Test
+  public void markdownJavadocComment() {
+    compilationTestHelper
+        .addSourceLines(
+            "Test.java",
+            "import static com.google.common.truth.Truth.assertThat;",
+            "class Test {",
+            "  public void f(int x) {}",
+            "  public void test() {",
+            "    f(",
+            "        /// javadoc markdown",
+            "        /* x= */ 42);",
+            "  }",
+            "}")
+        .doTest();
+  }
 }