com.puppycrawl.tools.checkstyle.checks.javadoc

Class PackageHtmlCheck

Implemented Interfaces:
Configurable, Contextualizable, FileSetCheck

public class PackageHtmlCheck
extends AbstractFileSetCheck

Checks that all packages have a package documentation.

An example of how to configure the check is:

 <module name="PackageHtml"/>
 

Author:
lkuehne

Constructor Summary

PackageHtmlCheck()
Creates a new PackageHtmlCheck instance.

Method Summary

protected Set
getParentDirs(File[] aFiles)
Returns the set of directories for a set of files.
void
process(File[] aFiles)
Checks that each java file in the fileset has a package.html sibling and fires errors for the missing files.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

destroy, filter, fireErrors, getCharset, getMessageCollector, getMessageDispatcher, log, log, setCharset, setFileExtensions, setMessageDispatcher

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

PackageHtmlCheck

public PackageHtmlCheck()
Creates a new PackageHtmlCheck instance.

Method Details

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.
Specified by:
process in interface FileSetCheck

Parameters:
aFiles - a set of files