com.puppycrawl.tools.checkstyle.checks.javadoc

Class PackageHtmlCheck

public class PackageHtmlCheck extends AbstractFileSetCheck

Checks that all packages have a package documentation.

Author: lkuehne

Constructor Summary
PackageHtmlCheck()
Creates a new PackageHtmlCheck instance.
Method Summary
protected SetgetParentDirs(File[] aFiles)
Returns the set of directories for a set of files.
voidprocess(File[] aFiles)
Checks that each java file in the fileset has a package.html sibling and fires errors for the missing files.

Constructor Detail

PackageHtmlCheck

public PackageHtmlCheck()
Creates a new PackageHtmlCheck instance.

Method Detail

getParentDirs

protected final Set getParentDirs(File[] aFiles)
Returns the set of directories for a set of files.

Parameters: aFiles s set of files

Returns: the set of parent directories of the given files

process

public void process(File[] aFiles)
Checks that each java file in the fileset has a package.html sibling and fires errors for the missing files.

Parameters: aFiles a set of files