Uses of Class
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Packages that use JavadocTag 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. -
-
Uses of JavadocTag in com.puppycrawl.tools.checkstyle.checks.imports
Methods in com.puppycrawl.tools.checkstyle.checks.imports that return types with arguments of type JavadocTag Modifier and Type Method Description private static List<JavadocTag>
UnusedImportsCheck. getValidTags(TextBlock cmt, JavadocUtil.JavadocTagType tagType)
Returns the list of valid tags found in a javadocTextBlock
.Methods in com.puppycrawl.tools.checkstyle.checks.imports with parameters of type JavadocTag Modifier and Type Method Description private static Set<String>
UnusedImportsCheck. processJavadocTag(JavadocTag tag)
Returns a list of references that found in a javadocJavadocTag
. -
Uses of JavadocTag in com.puppycrawl.tools.checkstyle.checks.javadoc
Fields in com.puppycrawl.tools.checkstyle.checks.javadoc with type parameters of type JavadocTag Modifier and Type Field Description private List<JavadocTag>
JavadocTags. validTags
Valid validTags.Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return types with arguments of type JavadocTag Modifier and Type Method Description private List<JavadocTag>
JavadocTypeCheck. getJavadocTags(TextBlock textBlock)
Gets all standalone tags from a given javadoc.private static List<JavadocTag>
JavadocMethodCheck. getMethodTags(TextBlock comment)
Returns the tags in a javadoc comment.private static List<JavadocTag>
JavadocMethodCheck. getMultilineNoArgTags(Matcher noargMultilineStart, String[] lines, int lineIndex, int tagLine)
Gets multiline Javadoc tags with no arguments.List<JavadocTag>
JavadocTags. getValidTags()
Getter for validTags field.Methods in com.puppycrawl.tools.checkstyle.checks.javadoc with parameters of type JavadocTag Modifier and Type Method Description private static String
JavadocTypeCheck. extractParamNameFromTag(JavadocTag tag)
Extracts parameter name from tag.Method parameters in com.puppycrawl.tools.checkstyle.checks.javadoc with type arguments of type JavadocTag Modifier and Type Method Description private void
JavadocTypeCheck. checkComponentParamTag(DetailAST ast, Collection<JavadocTag> tags, String recordComponentName)
Verifies that a record definition has the specified param tag for the specified record component name.private void
JavadocMethodCheck. checkParamTags(List<JavadocTag> tags, DetailAST parent, boolean reportExpectedTags)
Checks a set of tags for matching parameters.private void
JavadocMethodCheck. checkReturnTag(List<JavadocTag> tags, int lineNo, boolean reportExpectedTags)
Checks for only one return tag.private void
JavadocTypeCheck. checkTag(DetailAST ast, Iterable<JavadocTag> tags, String tagName, Pattern formatPattern)
Verifies that a type definition has a required tag.private void
JavadocMethodCheck. checkThrowsTags(List<JavadocTag> tags, List<JavadocMethodCheck.ExceptionInfo> throwsList, boolean reportExpectedTags)
Checks a set of tags for matching throws.private void
JavadocTypeCheck. checkTypeParamTag(DetailAST ast, Collection<JavadocTag> tags, String typeParamName)
Verifies that a type definition has the specified param tag for the specified type parameter name.private void
JavadocTypeCheck. checkUnusedParamTags(List<JavadocTag> tags, List<String> typeParamNames, List<String> recordComponentNames)
Checks for unused param tags for type parameters and record components.private boolean
JavadocMethodCheck. hasShortCircuitTag(DetailAST ast, List<JavadocTag> tags)
Validates whether the Javadoc has a short circuit tag.Constructor parameters in com.puppycrawl.tools.checkstyle.checks.javadoc with type arguments of type JavadocTag Constructor Description JavadocTags(Collection<JavadocTag> tags, Collection<InvalidJavadocTag> invalidTags)
Creates an instance.
-