Checks for Javadoc Comments |
![]() |
PackageHtmlDescriptionChecks that a package.html file exists for each package. More specifically, checks that each java file has a package.html sibling. Properties
ExampleTo configure the check: <module name="PackageHtml"/> Packagecom.puppycrawl.tools.checkstyle.checks.javadoc Parent ModuleJavadocTypeDescriptionChecks Javadoc comments for class and interface definitions. Properties
ExamplesTo configure the default check: <module name="JavadocType"/> To configure the check for public scope: <module name="JavadocType"> <property name="scope" value="public"/> </module> To configure the check for an @author tag: <module name="JavadocType"> <property name="authorFormat" value="\S"/> </module> To configure the check for a CVS revision version tag: <module name="JavadocType"> <property name="versionFormat" value="\$Revision.*\$"/> </module> To configure the check for private classes only: <module name="JavadocType"> <property name="scope" value="private"/> <property name="excludescope" value="package"/> </module> Packagecom.puppycrawl.tools.checkstyle.checks.javadoc Parent ModuleJavadocMethodDescriptionChecks to ensure that the following tags exist (if required):
For example, the following is valid: /** * Checks for a return tag. * @return the index of the next unchecked tag * @param aTagIndex the index to start in the tags * @param aTags the tags to check * @param aLineNo the line number of the expected tag **/ public int checkReturnTag(final int aTagIndex, JavadocTag[] aTags, int aLineNo) This supports the convention in the Sun Javadoc Guidelines and the "Effective Java" book. Properties
ExamplesTo configure the default check: <module name="JavadocMethod"/> To configure the check for public scope and to allow documentation of undeclared RuntimeExceptions: <module name="JavadocMethod"> <property name="scope" value="public"/> <property name="allowUndeclaredRTE" value="true"/> </module> To configure the check for methods which are in private , but not in protected scope: <module name="JavadocMethod"> <property name="scope" value="private"/> <property name="excludeScope" value="protected"/> </module> Notes
Packagecom.puppycrawl.tools.checkstyle.checks.javadoc Parent ModuleJavadocVariableDescriptionChecks that variables have Javadoc comments. Properties
ExamplesTo configure the default check: <module name="JavadocVariable"/> To configure the check for public scope: <module name="JavadocVariable"> <property name="scope" value="public"/> </module> To configure the check for members which are in private, but not in protected scope: <module name="JavadocVariable"> <property name="scope" value="private"/> <property name="excludeScope" value="protected"/> </module> Packagecom.puppycrawl.tools.checkstyle.checks.javadoc Parent ModuleJavadocStyleDescriptionValidates Javadoc comments to help ensure they are well formed. The following checks are performed:
These checks were patterned after the checks made by the DocCheck doclet available from Sun. Properties
ExamplesTo configure the default check: <module name="JavadocStyle"/> To configure the check for public scope: <module name="JavadocStyle"> <property name="scope" value="public"/> </module> To configure the check for javadoc which is in private, but not in package scope: <module name="JavadocStyle"> <property name="scope" value="private"/> <property name="excludeScope" value="package"/> </module> To configure the check to turn off first sentence checking: <module name="JavadocStyle"> <property name="checkFirstSentence" value="false"/> </module>
Packagecom.puppycrawl.tools.checkstyle.checks Parent Module |
Copyright © 2002-2003 Oliver Burn. All rights Reserved.