Skip to content

Files

Latest commit

 

History

History
65 lines (38 loc) · 1.68 KB

JavadocType.md

File metadata and controls

65 lines (38 loc) · 1.68 KB

Pattern: Wrong Javadoc comment

Issue: -

Description

Checks Javadoc comments for class and interface definitions. By default, does not check for author or version tags. The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to one of the Scope constants. To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression.

Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.

Error messages about type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.

Examples

To configure the default check:

<module name="JavadocType"/>

To configure the check for public scope:

<module name="JavadocType">
   <property name="scope" value="public"/>
</module>

To configure the check for an @author tag:

<module name="JavadocType">
   <property name="authorFormat" value="\S"/>
</module>

To configure the check for a CVS revision version tag:

<module name="JavadocType">
   <property name="versionFormat" value="\$Revision.*\$"/>
</module>

To configure the check for private classes only:

<module name="JavadocType">
   <property name="scope" value="private"/>
   <property name="excludeScope" value="package"/>
</module>

Further Reading