checkstyle / checkstyle/checkstyle
JavadocParagraph: Allow disable empty line check
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 4.2k
- Avg merge
- 22h 23m
- Merged PRs (30d)
- 232
Description
---------------
I am using [PegdownDoclet](https://github.com/Abnaxos/markdown-doclet) in my Java project, thus I could safely document JavaDoc in Markdown format, in which case the `
` tag is not required.
However I found checkstyle always report:
```
Empty line should be followed by
tag on the next line.
```
And I can't find any configuration to disable it.
--------------
This request is to have checkstyle provides a configuration to disable the empty line check
Contributor guide
Research direction
Start with the JavadocParagraph check and its existing configuration and diagnostic for empty lines. Add a configuration option that disables this check, then verify that JavaDoc using Markdown-style paragraphs no longer reports the empty-line error while the default behavior remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100