Skip to content

fix UnnecessaryInheritDoc Qodana warnings in Javadoc-related source files #19895

@ZaheerAhmadDev

Description

@ZaheerAhmadDev

Qodana reports UnnecessaryInheritDoc warnings on several files where
{@inheritDoc} appears inside {@code} blocks for documentation purposes:

  • src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java
  • src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
  • src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagInfo.java
  • src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java
  • src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.java
  • src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java

These are false positives — the tag is being used descriptively inside {@code},
not as a live Javadoc directive. The root cause may be related to our
javadoc-to-xdoc translation logic. Investigation needed to find a proper fix
that does not require suppression.

Temporarily suppressed in config/qodana.yaml at PR #19880.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions