Skip to content

Files

Latest commit

 

History

History
26 lines (18 loc) · 696 Bytes

JavadocMissingParamDescription.md

File metadata and controls

26 lines (18 loc) · 696 Bytes

Pattern: Missing @param description in Javadoc

Issue: -

Description

Checks for missing description within Javadoc @param tags.

Known limitation: Only the first occurrence of a missing description for a @param Javadoc comment is found.

Example of violations:

/**
 * Return the calculated count of some stuff.
 *
 * @param startIndex                           // violation
 * @return the full count
 * @throws RuntimeException if it senses fear
 */
int countThings(int startIndex) { }

Further Reading