Warn when {@inheritDoc} is used on a non-inheriting method, class, or interface
- Dominant language
- Java
- Stars
- 3.1k
- Forks
- 935
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 17
Description
### 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
Contributor guide
Research direction
No file, test, or entry point is named; start by locating the NetBeans Java editor's Javadoc analysis and existing warning diagnostics. Done means the editor warns when {@inheritDoc} appears on a method, class, or interface without an inheritance relationship.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100