Uses of Record Class
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocSeeTagOrderCheck.SeeReference
Packages that use JavadocSeeTagOrderCheck.SeeReference
Package
Description
Contains the Javadoc checks that are bundled with the main distribution.
-
Uses of JavadocSeeTagOrderCheck.SeeReference in com.puppycrawl.tools.checkstyle.checks.javadoc
Fields in com.puppycrawl.tools.checkstyle.checks.javadoc declared as JavadocSeeTagOrderCheck.SeeReferenceModifier and TypeFieldDescriptionJavadocSeeTagOrderCheck.maxReferenceThe most distant structural position seen so far in the current Javadoc tree.JavadocSeeTagOrderCheck.previousReferenceThe reference that immediately precedes the current one.Fields in com.puppycrawl.tools.checkstyle.checks.javadoc with type parameters of type JavadocSeeTagOrderCheck.SeeReferenceModifier and TypeFieldDescriptionJavadocSeeTagOrderCheck.lastByNameThe most recent reference for each member name within the current Javadoc tree.Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return JavadocSeeTagOrderCheck.SeeReferenceModifier and TypeMethodDescriptionprivate static JavadocSeeTagOrderCheck.SeeReferenceJavadocSeeTagOrderCheck.SeeReference.from(DetailNode seeBlock, String enclosingTypeName) Parses a@seeblock tag into aSeeReference, or returnsnullif the reference is not in a form that can be confidently ordered.private static JavadocSeeTagOrderCheck.SeeReferenceJavadocSeeTagOrderCheck.SeeReference.parseIdentifierReference(DetailNode reference, DetailNode identifierNode) Parses an identifier-based reference (simple or qualified type, member, or package reference).private static JavadocSeeTagOrderCheck.SeeReferenceJavadocSeeTagOrderCheck.SeeReference.parseMember(DetailNode member, String qualifier, JavadocSeeTagOrderCheck.Category category, String ownerSimpleName) Parses a member reference (local member or class member).Methods in com.puppycrawl.tools.checkstyle.checks.javadoc with parameters of type JavadocSeeTagOrderCheck.SeeReferenceModifier and TypeMethodDescriptionprivate booleanJavadocSeeTagOrderCheck.isGroupingViolation(JavadocSeeTagOrderCheck.SeeReference current) Checks whether the current reference breaks the grouping of overloaded members with the same name.private static booleanJavadocSeeTagOrderCheck.isStructuralViolation(JavadocSeeTagOrderCheck.SeeReference current, JavadocSeeTagOrderCheck.SeeReference maximum) Checks whether the current reference breaks the structural order (category and field-before-constructor-before-method).private booleanJavadocSeeTagOrderCheck.isTelescopingViolation(JavadocSeeTagOrderCheck.SeeReference current) Checks whether the current reference breaks the telescoping order of an overloaded constructor or method with the same name.private static StringJavadocSeeTagOrderCheck.lastByKey(JavadocSeeTagOrderCheck.SeeReference reference) Returns the map key that scopes a member name to its owning type and category group, so that grouping and telescoping checks only apply to overloads of the same member on the same type.(package private) booleanJavadocSeeTagOrderCheck.SeeReference.structurallyAfterThan(JavadocSeeTagOrderCheck.SeeReference other) Checks whether this reference is structurally after the given reference.