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:

  class Example {
    /**
     * @see Example#method
     */
    public void method() { }
  }

After the quick-fix is applied:

class Example {
  public void method() { }
}

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

UnnecessaryJavaDocLink

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Java | Javadoc

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

Here you can find the description of settings available for the Unnecessary Javadoc link inspection, and the reference of their default values.

Ignore inline links to super methods: Not selected

Availability

By default bundled with: IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,
Can be installed with plugin: Java, 241.18072

Last modified: 18 June 2024