Missing Javadoc

Reports missing Javadoc comments and tags.

Example:

/**
 * 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){
}

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

Option	Type	Default
Ignore elements marked as @deprecated	Checkbox	false
Ignore simple property accessors	Checkbox	false
	CheckboxPanel	None
Package	Checkbox	true
Required tags	Group	None
@author	Checkbox	false
@version	Checkbox	false
@since	Checkbox	false
Module	Checkbox	true
Required tags	Group	None
@author	Checkbox	false
@version	Checkbox	false
@since	Checkbox	false
Class	Checkbox	true
Minimal visibility	Dropdown	public
Required tags	Group	None
@author	Checkbox	false
@version	Checkbox	false
@since	Checkbox	false
@param	Checkbox	true
Method	Checkbox	true
Minimal visibility	Dropdown	public
Required tags	Group	None
@return	Checkbox	true
@param	Checkbox	true
@throws or @exception	Checkbox	true
Field	Checkbox	true
Minimal visibility	Dropdown	public
Inner class	Checkbox	true
Minimal visibility	Dropdown	public

Inspection Details
Available in:	IntelliJ IDEA 2023.3, Qodana for JVM 2023.3
Plugin:	Java, 233.SNAPSHOT

Last modified: 13 July 2023