Inspectopedia Help

Missing Javadoc

Reports missing Javadoc comments and tags.


/** * Missing "@param" is reported (if configured). */ public void sample(int param){ }

The quick-fixes add missing tag or missing Javadoc comment:

/** * Missing "@param" is reported (if configured). * @param param */ public void sample(int param){ }

Locating this inspection


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

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

Inspection can be configured to ignore deprecated elements or simple accessor methods like getField() or setField().

You can also use options below to configure required tags and minimal required visibility for the specific code elements like method, field, class, package, module.

Inspection options

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

Ignore elements marked as @deprecated

Not selected

Ignore simple property accessors

Not selected


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