com.puppycrawl.tools.checkstyle.checks.javadoc
Class PackageHtmlCheck
- Configurable, Contextualizable, FileSetCheck
public class PackageHtmlCheck
Checks that all packages have a package documentation.
An example of how to configure the check is:
<module name="PackageHtml"/>
- lkuehne
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.
|
destroy , filter , fireErrors , getCharset , getMessageCollector , getMessageDispatcher , log , log , setCharset , setFileExtensions , setMessageDispatcher |
getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setSeverity |
PackageHtmlCheck
public PackageHtmlCheck()
Creates a new PackageHtmlCheck
instance.
getParentDirs
protected final Set getParentDirs(File[] aFiles)
Returns the set of directories for a set of files.
aFiles
- s set of files
- 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.
- process in interface FileSetCheck
aFiles
- a set of files