Fork me on GitHub

OpenJavaDocCheck

Missing JavaDoc Description

Priority: ERROR

Checks if the class or method is missing a JavaDoc description

Exception Tag Has Template Content

Priority: ERROR

Checks if the @exception content is a template default

Parameter Tag Has Template Content

Priority: ERROR

Checks if the @param content is a template default

Missing Exception Description

Priority: ERROR

Checks whether a class that throws anexception, describes when the exception is thrown with @throws or @exception

Missing Return Tag

Priority: ERROR

Checks whether a class that does not return void has a @return tag.

Missing Param Tag

Priority: ERROR

Checks whether a method has @param tags for all parameters.

First Sentence Period

Priority: ERROR

Tests if the first sentence ends with a period.

Return, not returns.

Priority: WARNING

Warns about @returns tag presence.

Only One Version Tag

Priority: ERROR

Checks if more than one @version tag is given on a Class.