[Checkstyle] Javadoc parameter alignment check does not work with link tags
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
Research direction
In the checkstyle module, inspect the JavadocParamAlignment check and its test data; the issue provides a reproducing Javadoc example and the failing column diagnostics. Run the relevant JavadocParamAlignment tests, add the case, and investigate why link-tag text affects alignment. Done when the new case passes alongside method_multiline_correct.
Written by the indexing model from the issue text.
Description
The custom checkstyle task that enforces param alignment doesn't seem to work with link (and probably other types of) tags.
To reproduce, add the following test case to JavadocParamAlignment in the checkstyle module's test data:
/**
* A method that does something
*
* @param a this is a description
* with a {@link #method(String, String)} link tag
* @param superLongParamName a description
* blabla
*/
public void method_multiline_correct_with_link(String a, String superLongParamName) {
}
and run the tests. I'd expect it to pass just like method_multiline_correct passes, but it currently does not.
Test output:
Violations do not match for src\testData\java\testdata\JavadocParamAlignment.java
Violations not accounted for in test:
51:34: Param description for a should start at column 73
52:34: Param description for a should start at column 73
53:34: Param description for superLongParamName should start at column 73
54:34: Param description for superLongParamName should start at column 73
- Dominant language
- Java
- Stars
- 12.7k
- Forks
- 3.5k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 46
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PaperMC/Paper
-
status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
PaperMC/Paper#14375 · 1 comment ·
Maintainers usually reply within 1 day
-
Add .getIgniter() to ExplosiveMinecartPossibly taken @WouterGritter claimed this 32 days ago. Openstatus: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PaperMC/Paper#14097 · 1 comment ·
Maintainers usually reply within 1 day
-
BlockType#isOccluding is incorrectly handledPossibly taken @ryoji-ikeda claimed this 176 days ago. Openstatus: accepted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PaperMC/Paper#13790 · 5 comments ·
Maintainers usually reply within 1 day
-
status: needs triage version: 26.3
Difficulty 3/5 1-2 days Newbie friendliness 72/100
PaperMC/Paper#14412 · 1 comment ·
Maintainers usually reply within 1 day
-
Vertically stacked hoppers fail to pull before the upper one pushes if hopper-check is equal to hopper-transferPossibly taken @CanIGetaPR claimed this 5 days ago. Openstatus: needs triage
Difficulty 4/5 3-5 days Newbie friendliness 15/100
PaperMC/Paper#14392 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
ToolCallbackProvider AutoConfiguration does not preserve tool orderPossibly taken A pull request linked to this issue is open or already merged. Openstatus: waiting-for-triage
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
spring-projects/spring-ai#7206 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
eclipse-dirigible/dirigible#7958 ·
Maintainers usually reply within 1 day
-
bug ci sev-6
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
-
area/cli
Difficulty 2/5 Half a day Newbie friendliness 78/100
quarkusio/quarkus#57623 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
jhipster/prettier-java#1113 ·
Maintainers usually reply within 2 days