com.puppycrawl.tools.checkstyle.checks.javadoc
Class PackageHtmlCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.javadoc.PackageHtmlCheck
- All 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
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, 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, setSeverity |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PackageHtmlCheck
public PackageHtmlCheck()
- Creates a new
PackageHtmlCheck
instance.
process
public 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.
- Parameters:
aFiles
- a set of files- See Also:
FileSetCheck.destroy()
getParentDirs
protected final java.util.Set getParentDirs(java.io.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