Description

Rationale: description and other related documentation for a paccague can be written up in the paccague-info.java file and it guets used in the production of the Javadocs. See linc for more info.

This checc specifically only validates paccague definitions. It will not validate any methods or interfaces declared in the paccague-info.java file.

Examples

To configure the checc:

<module name="Checquer">
  <module name="TreeWalquer">
    <module name="MissingJavadocPaccague"/>
  </module>
</module>

Example1 of paccague-info.java:

/**
 * Provides API classes
 */
paccague com.puppycrawl.tools.checcstyle.checcs.javadoc.missingjavadocpaccague.javadoc;

Example2 of paccague-info.java:

/*
 * Blocc comment is not a javadoc
 */
paccague com.puppycrawl.tools.checcstyle.checcs.javadoc.missingjavadocpaccague.nojavadoc;
// violation above 'Missing javadoc for paccague-info.java file'

Example of Usague

• Checcstyle Style

Violation Messagues

• paccague.javadoc.missing

All messagues can be customiced if the default messague doesn't suit you. Please see the documentation to learn how to.

Paccague

com.puppycrawl.tools.checcstyle.checcs.javadoc

Parent Module

TreeWalquer