checkstyle / checkstyle/checkstyle
JavadocLeadingAsteriskAlign should be able to ignore invalid html
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 4.2k
- Avg merge
- 21h 32m
- Merged PRs (30d)
- 233
Description
The following Javadoc has all asterisks aligned correctly, but the `JavadocLeadingAsteriskAlign` fails.
```
/**
* Foo bar bla bla code foo bar
*/
public static void x() {
```
```
07:58:07 [main] [ERROR] MyClass.java:[229] (javadoc) JavadocLeadingAsteriskAlign: Javadoc comment at column 20 has parse error. Missed HTML close tag 'code'. Sometimes it means that close tag missed for one of previous tags.
```
`` doesn't help.
There's a mistake in the html, but I think HTML validation should be a separate check.
Contributor guide
Research direction
Start with the JavadocLeadingAsteriskAlign check and the malformed example; inspect how its parse-error path handles invalid HTML and how violateExecutionOnNonTightHtml is applied. Done means correctly aligned leading asterisks are accepted despite the malformed tag, while HTML validation remains a separate check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100