Package | Description |
---|---|
com.puppycrawl.tools.checkstyle.checks.imports |
Contains the Imports checks that are
bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.utils |
Contains utils classes for checkstyle.
|
Modifier and Type | Method and Description |
---|---|
private static java.util.List<JavadocTag> |
UnusedImportsCheck.getValidTags(TextBlock cmt,
JavadocUtils.JavadocTagType tagType)
Returns the list of valid tags found in a javadoc
TextBlock . |
Modifier and Type | Method and Description |
---|---|
private static java.util.Set<java.lang.String> |
UnusedImportsCheck.processJavadocTag(JavadocTag tag)
Returns a list of references found in a javadoc
JavadocTag . |
Modifier and Type | Field and Description |
---|---|
private java.util.List<JavadocTag> |
JavadocTags.validTags
Valid validTags.
|
Modifier and Type | Method and Description |
---|---|
private java.util.List<JavadocTag> |
JavadocTypeCheck.getJavadocTags(TextBlock textBlock)
Gets all standalone tags from a given javadoc.
|
private static java.util.List<JavadocTag> |
JavadocMethodCheck.getMethodTags(TextBlock comment)
Returns the tags in a javadoc comment.
|
private static java.util.List<JavadocTag> |
JavadocMethodCheck.getMultilineArgTags(java.util.regex.Matcher argMultilineStart,
int column,
java.lang.String[] lines,
int lineIndex,
int tagLine)
Gets multiline Javadoc tags with arguments.
|
private static java.util.List<JavadocTag> |
JavadocMethodCheck.getMultilineNoArgTags(java.util.regex.Matcher noargMultilineStart,
java.lang.String[] lines,
int lineIndex,
int tagLine)
Gets multiline Javadoc tags with no arguments.
|
java.util.List<JavadocTag> |
JavadocTags.getValidTags()
Getter for validTags field.
|
Modifier and Type | Method and Description |
---|---|
private static java.lang.String |
JavadocTypeCheck.extractTypeParamNameFromTag(JavadocTag tag)
Extracts type parameter name from tag.
|
Modifier and Type | Method and Description |
---|---|
private void |
JavadocMethodCheck.checkParamTags(java.util.List<JavadocTag> tags,
DetailAST parent,
boolean reportExpectedTags)
Checks a set of tags for matching parameters.
|
private void |
JavadocMethodCheck.checkReturnTag(java.util.List<JavadocTag> tags,
int lineNo,
boolean reportExpectedTags)
Checks for only one return tag.
|
private void |
JavadocTypeCheck.checkTag(int lineNo,
java.util.List<JavadocTag> tags,
java.lang.String tagName,
java.util.regex.Pattern formatPattern)
Verifies that a type definition has a required tag.
|
private void |
JavadocMethodCheck.checkThrowsTags(java.util.List<JavadocTag> tags,
java.util.List<JavadocMethodCheck.ExceptionInfo> throwsList,
boolean reportExpectedTags)
Checks a set of tags for matching throws.
|
private void |
JavadocTypeCheck.checkTypeParamTag(int lineNo,
java.util.List<JavadocTag> tags,
java.lang.String typeParamName)
Verifies that a type definition has the specified param tag for
the specified type parameter name.
|
private void |
JavadocTypeCheck.checkUnusedTypeParamTags(java.util.List<JavadocTag> tags,
java.util.List<java.lang.String> typeParamNames)
Checks for unused param tags for type parameters.
|
private boolean |
JavadocMethodCheck.hasShortCircuitTag(DetailAST ast,
java.util.List<JavadocTag> tags)
Validates whether the Javadoc has a short circuit tag.
|
Constructor and Description |
---|
JavadocTags(java.util.List<JavadocTag> tags,
java.util.List<InvalidJavadocTag> invalidTags)
Creates an instance.
|
Modifier and Type | Method and Description |
---|---|
private static void |
JavadocUtils.lookForInlineTags(TextBlock comment,
int lineNumber,
java.util.List<JavadocTag> validTags,
java.util.List<InvalidJavadocTag> invalidTags)
Looks for inline tags in comment and adds them to the proper tags collection.
|