Skip to content

Commit 0290815

Browse files
SONARJAVA-5445 S1123 Add tests for markdown JavaDoc (#5149)
1 parent f239443 commit 0290815

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package checks;
2+
3+
class MissingDeprecatedCheckMarkdownSample {
4+
5+
@Deprecated(since = "R1.3")
6+
public void annotated() {} // Noncompliant
7+
8+
/// Markdown doc, but not tag.
9+
@Deprecated(since = "R1.3")
10+
public void annotatedJavaDoc() {} // Noncompliant
11+
12+
/// Markdown doc with a tag.
13+
/// @deprecated for a good reason
14+
@Deprecated(since = "R1.3")
15+
public void annotatedJavaDocTag() {} // Compliant
16+
17+
/// Markdown doc with a tag.
18+
/// @deprecated for a good reason
19+
public void justTag() {} // Noncompliant
20+
}

java-checks/src/test/java/org/sonar/java/checks/MissingDeprecatedCheckTest.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,11 @@ void test_records() {
4949
.verifyIssues();
5050
}
5151

52+
@Test
53+
void test_markdown() {
54+
CheckVerifier.newVerifier()
55+
.onFile(mainCodeSourcesPath("checks/MissingDeprecatedCheckMarkdownSample.java"))
56+
.withCheck(new MissingDeprecatedCheck())
57+
.verifyIssues();
58+
}
5259
}

0 commit comments

Comments
 (0)