Unnecessary Javadoc link
Reports Javadoc @see
, {@link}
, and {@linkplain}
tags that refer to the method owning the comment, the super method of the method owning the comment, or the class containing the comment.
Such links are unnecessary and can be safely removed with this inspection's quick-fix. The quick-fix will remove the entire Javadoc comment if the tag is its only content.
Example:
After the quick-fix is applied:
Use the checkbox below to ignore inline links ({@link}
and {@linkplain}
) to super methods. Although a link to all super methods is automatically added by the Javadoc tool, an inline link to the super method may sometimes be needed in texts of the Javadoc comments.
Inspection options
Option | Type | Default |
---|---|---|
Ignore inline links to super methods | Checkbox | false |
Inspection Details | |
---|---|
Available in: | IntelliJ IDEA 2023.3, Qodana for JVM 2023.3 |
Plugin: | Java, 233.SNAPSHOT |