Javadoc declaration problems

Reports Javadoc comments and tags with the following problems:

Example:

  /**
   * Invalid tag name
   * @poram param description
   */
  public void sample(int param){
  }

Example:

  /**
   * Pointing to itself {@link #sample(int)}
   */
  public void sample(int param){
  }

Quick-fix adds the unknown Javadoc tag to the list of user defined additional tags.

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.

javadoc

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 textfield below to define additional Javadoc tags.

Use first checkbox to ignore duplicated 'throws' tag.

Use second checkbox to ignore problem with missing or incomplete first sentence in the description.

Use third checkbox to ignore references pointing to itself.

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

Inspection Details
By default bundled with:	IntelliJ IDEA 2024.3, Qodana for JVM 2024.3,
Can be installed with plugin:	Java, 243.23126

Last modified: 03 December 2024