Package com.puppycrawl.tools.checkstyle.checks.javadoc
package com.puppycrawl.tools.checkstyle.checks.javadoc
Contains the Javadoc checks that are bundled with the main distribution.
-
ClassDescriptionBase class for Checks that process Javadoc comments.Checks the order of javadoc block-tags or javadoc tags.Checks that Javadocs are located at the correct position.Value object for storing data about an invalid Javadoc validTags.Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.Represents the locations for the javadoc content.Checks the Javadoc of a method or constructor.Checks that there is at least one whitespace after the leading asterisk.Implementation of DetailNode interface that is mutable.Checks that each Java package has a Javadoc file used for commenting.Checks the Javadoc paragraph.Validates Javadoc comments to help ensure they are well formed.Represents a Javadoc tag.Checks the indentation of the continuation lines in at-clauses.This enum defines the various Javadoc tags and there properties.The Javadoc Type.Value object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment.Checks the Javadoc comments for annotation/enum/class/interface definitions.Checks that a variable has a Javadoc comment.Checks for missing Javadoc comments for a method or constructor.Checks for missing Javadoc comments in package-info.java files.Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.Checks that the at-clause tag is followed by description.Checks that one blank line before the block tag if it is present in Javadoc.Checks that a Javadoc block can fit in a single line and doesn't contain at-clauses.Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.Requires user defined Javadoc tag to be present in Javadoc comment with defined format.