Skip to content

Warn when {@inheritDoc} is used on a non-inheriting method, class, or interface #9457

Description

@nmatt

Description

Show a warning in the editor when a javadoc comment on a non-inheriting method, class, or interface uses the {@inheritDoc} tag.

Use case/motivation

When copying javadoc between related methods or classes, and/or when the inheritance relationship changes, {@inheritDoc} tags have to be removed when they become inapplicable. A warning helps drawing attention to such situations.

Related issues

No response

Are you willing to submit a pull request?

No

Metadata

Metadata

Assignees

No one assigned

    Labels

    Java[ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form)JavaDoc[ci] enable java/javadoc tests and build-javadoc targethintskind:featureA feature request

    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