|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck
Checks that all packages have a package documentation.
An example of how to configure the check is:
<module name="PackageHtml"/>
Constructor Summary | |
PackageHtmlCheck()
Creates a new PackageHtmlCheck instance. |
Method Summary | |
protected java.util.Set |
getParentDirs(java.io.File[] aFiles)
Returns the set of directories for a set of files. |
void |
process(java.io.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, getMessageCollector, getMessageDispatcher, log, log, setFileExtensions, setMessageDispatcher |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, setSeverity |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable |
configure |
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable |
contextualize |
Constructor Detail |
public PackageHtmlCheck()
PackageHtmlCheck
instance.
Method Detail |
public void process(java.io.File[] aFiles)
aFiles
- a set of filesFileSetCheck.destroy()
protected final java.util.Set getParentDirs(java.io.File[] aFiles)
aFiles
- s set of files
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |