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.The file context holder.Checks the order of javadoc block-tags or javadoc tags.Used to keep track of a tag and the text that follows it.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 alignment of leading asterisks in a Javadoc comment.Checks the Javadoc of a method or constructor.Contains class's
Token.Stores useful information about declared exception.Represents text element with location in the text.Checks if the javadoc has leading asterisks on each line.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 block tags.This enum defines the various Javadoc tags and their 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 type definitions.Checks that a variable has a Javadoc comment.Checks for missing Javadoc comments for a method or constructor.Checks for missing package definition Javadoc comments in package-info.java files.Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.Checks that the block 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 block tags.Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.Helper class used to parse HTML tags or generic type identifiers from a single-line of text.Represents current position in the text.Requires user defined Javadoc tag to be present in Javadoc comment with defined format.