Description

Package definitions do not have return types or throw declarations. Therefore, @return and @throws/@exception Javadoc block tags used in their Javadoc comments are considered inappropriate and should be removed or replaced with proper documentation.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.inappropriate.tag

Properties

Examples

To configure the check to report inappropriate type Javadoc block tags:

<module name="Checker">
  <module name="TreeWalker">
    <module name="InappropriateJavadocBlockTagsOnPackage"/>
  </module>
</module>

Example:

/**
 * Invalid Javadoc comment
 *
 * @param value This doesn't exist
 * @return
 */
package com.puppycrawl.tools.checkstyle.checks.javadoc.inappropriatejavadocblocktagsonpackage;
// 2 violations above:
// 'Invalid '@param' tag for 'package'.'
// 'Invalid '@return' tag for 'package'.'

To configure the check to report inappropriate type Javadoc block tags:

<module name="Checker">
  <module name="TreeWalker">
    <module name="InappropriateJavadocBlockTagsOnPackage"/>
  </module>
</module>

Example:

/**
 * Valid Javadoc comment
 *
 * @author Unknown
 * @version 1.0
 */
package com.puppycrawl.tools.checkstyle.checks.javadoc.inappropriatejavadocblocktagsonpackage;

Example of Usage

• Checkstyle Style

Violation Messages

• javadoc.inappropriate.tag
• javadoc.parse.rule.error
• javadoc.unclosedHtml

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Fully Qualified Name

com.puppycrawl.tools.checkstyle.checks.javadoc.InappropriateJavadocBlockTagsOnPackageCheck

Use this fully qualified class name in configuration when an exact class reference is required.

Parent Module

TreeWalker