Skip to content

[Checkstyle] Javadoc parameter alignment check does not work with inlined tags #14405

Closed

Description

@Warriorrrr

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

Activity

  1. added theissue type on Oct 27, 2026
  2. added
    status: acceptedDisputed bug is accepted as valid or Feature accepted as desired to be added.
    and removed
    type: bugSomething doesn't work as it was intended to.
    on Oct 27, 2026
  3. changed the title [-][Checkstyle] Javadoc parameter alignment check does not work with link tags[/-] [+][Checkstyle] Javadoc parameter alignment check does not work with inlined tags[/+] on Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: acceptedDisputed bug is accepted as valid or Feature accepted as desired to be added.

    Type

    Fields

    MC Issue

    None yet

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions