OpenJDK 27 · jdk.javadoc.internal.doclint.Checker · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static enum	Checker.Flag
pack-priv static class	Checker.TagStackItem

Modifier and Type	Field and Description
private HtmlTag	currHeadingTag
private static final Pattern	docRoot
pack-priv final Env	env
pack-priv Map<Element, Set<String>>	foundAnchors
pack-priv boolean	foundInheritDoc
pack-priv Set<Element>	foundParams
pack-priv boolean	foundReturn
pack-priv Set<TypeMirror>	foundThrows
pack-priv boolean	hasNonWhitespaceText
private int	implicitHeadingRank
private boolean	inIndex
private boolean	inLink
private boolean	inSee
private boolean	inSummary
private final Deque<Checker.TagStackItem>	tagStack
private static final Pattern	validId
private static final Pattern	validNumber

Access	Constructor and Description
pack-priv	Checker(Env env)

Method Summary

Modifier and Type	Method and Description
pack-priv void	checkAllowsText(DocTree tree)
private boolean	checkAnchor(String name)
private void	checkHeading(StartElementTree tree, HtmlTag tag)
private void	checkParamsDocumented(List<? extends Element> list)
private void	checkStructure(StartElementTree tree, HtmlTag t)
private void	checkTagStack()
private void	checkThrowsDeclared(ReferenceTree tree, TypeMirror t, List<? extends TypeMirror> list)
private void	checkThrowsDocumented(List<? extends TypeMirror> list)
private void	checkUnknownTag(DocTree tree, String tagName)
private void	checkURI(AttributeTree tree, String uri)
private String	getAttrValue(AttributeTree tree)
private Element	getEnclosingPackageOrClass(Element e)
private int	getHeadingRank(HtmlTag tag)
private DocTree.Kind	getParentKind()
private Set<String>	getStandardTags()
pack-priv boolean	hasNonWhitespace(TextTree tree)
private boolean	isAnonymous()
private static boolean	isBlank(DocTree t)
private boolean	isCanonicalRecordConstructor(ExecutableElement ee)
private boolean	isCheckedException(TypeMirror t)
private boolean	isConstant(Element e)
private boolean	isDeclaredType()
private boolean	isDefaultConstructor()
private boolean	isExecutable()
private boolean	isImplicitlyDeclaredClass(Tree t)
private boolean	isNormalClass(TreePath p)
private boolean	isRecordComponentOrField()
private boolean	isSelfClosingAllowed(HtmlTag tag)
private boolean	isSynthetic()
private boolean	isThrowable(TypeMirror tm)
pack-priv void	markEnclosingTag(Checker.Flag flag)
private boolean	pseudoElement(TreePath p)
private void	reportBadReference(ReferenceTree tree)
private void	reportMissing(String code, Object... args)
private void	reportReference(String code, Object... args)
public Void	scan(DocCommentTree tree, TreePath p)
public Void	scan(DocTreePath path, Void unused) Overrides com.sun.source.util.DocTreePathScanner.scan. Scans a tree from a position identified by a tree path.
pack-priv String	toString(TreePath p)
pack-priv void	toString(TreePath p, StringBuilder sb)
public Void	visitAttribute(AttributeTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitAttribute. Implements com.sun.source.doctree.DocTreeVisitor.visitAttribute. Visits an `AttributeTree` node.
public Void	visitAuthor(AuthorTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitAuthor. Implements com.sun.source.doctree.DocTreeVisitor.visitAuthor. Visits an `AuthorTree` node.
public Void	visitDocComment(DocCommentTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitDocComment. Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment. Visits a `DocCommentTree` node.
public Void	visitDocRoot(DocRootTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitDocRoot. Implements com.sun.source.doctree.DocTreeVisitor.visitDocRoot. Visits a `DocRootTree` node.
public Void	visitEndElement(EndElementTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitEndElement. Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement. Visits an `EndElementTree` node.
public Void	visitEntity(EntityTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitEntity. Implements com.sun.source.doctree.DocTreeVisitor.visitEntity. Visits an `EntityTree` node.
public Void	visitErroneous(ErroneousTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitErroneous. Implements com.sun.source.doctree.DocTreeVisitor.visitErroneous. Visits an `ErroneousTree` node.
public Void	visitEscape(EscapeTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitEscape. Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape. Visits an `EscapeTree` node.
public Void	visitIndex(IndexTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitIndex. Overrides default com.sun.source.doctree.DocTreeVisitor.visitIndex. Visits an `IndexTree` node.
public Void	visitInheritDoc(InheritDocTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitInheritDoc. Implements com.sun.source.doctree.DocTreeVisitor.visitInheritDoc. Visits an `InheritDocTree` node.
public Void	visitLink(LinkTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitLink. Implements com.sun.source.doctree.DocTreeVisitor.visitLink. Visits a `LinkTree` node.
public Void	visitLiteral(LiteralTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitLiteral. Implements com.sun.source.doctree.DocTreeVisitor.visitLiteral. Visits an `LiteralTree` node.
public Void	visitParam(ParamTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitParam. Implements com.sun.source.doctree.DocTreeVisitor.visitParam. Visits a `ParamTree` node.
public Void	visitProvides(ProvidesTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitProvides. Overrides default com.sun.source.doctree.DocTreeVisitor.visitProvides. Visits a `ProvidesTree` node.
public Void	visitReference(ReferenceTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitReference. Implements com.sun.source.doctree.DocTreeVisitor.visitReference. Visits a `ReferenceTree` node.
public Void	visitReturn(ReturnTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitReturn. Implements com.sun.source.doctree.DocTreeVisitor.visitReturn. Visits a `ReturnTree` node.
public Void	visitSee(SeeTree node, Void unused) Overrides com.sun.source.util.DocTreeScanner.visitSee. Implements com.sun.source.doctree.DocTreeVisitor.visitSee. Visits a `SeeTree` node.
public Void	visitSerialData(SerialDataTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitSerialData. Implements com.sun.source.doctree.DocTreeVisitor.visitSerialData. Visits a `SerialDataTree` node.
public Void	visitSerialField(SerialFieldTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitSerialField. Implements com.sun.source.doctree.DocTreeVisitor.visitSerialField. Visits a `SerialFieldTree` node.
public Void	visitSince(SinceTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitSince. Implements com.sun.source.doctree.DocTreeVisitor.visitSince. Visits a `SinceTree` node.
public Void	visitStartElement(StartElementTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitStartElement. Implements com.sun.source.doctree.DocTreeVisitor.visitStartElement. Visits a `StartElementTree` node.
public Void	visitSummary(SummaryTree tree, Void aVoid) Overrides com.sun.source.util.DocTreeScanner.visitSummary. Overrides default com.sun.source.doctree.DocTreeVisitor.visitSummary. Visits a `SummaryTree` node.
public Void	visitSystemProperty(SystemPropertyTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitSystemProperty. Overrides default com.sun.source.doctree.DocTreeVisitor.visitSystemProperty. Visits a `SystemPropertyTree` node.
public Void	visitText(TextTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitText. Implements com.sun.source.doctree.DocTreeVisitor.visitText. Visits a `TextTree` node.
public Void	visitThrows(ThrowsTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitThrows. Implements com.sun.source.doctree.DocTreeVisitor.visitThrows. Visits a `ThrowsTree` node.
public Void	visitUnknownBlockTag(UnknownBlockTagTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitUnknownBlockTag. Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownBlockTag. Visits an `UnknownBlockTagTree` node.
public Void	visitUnknownInlineTag(UnknownInlineTagTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitUnknownInlineTag. Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownInlineTag. Visits an `UnknownInlineTagTree` node.
public Void	visitUses(UsesTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitUses. Overrides default com.sun.source.doctree.DocTreeVisitor.visitUses. Visits a `UsesTree` node.
public Void	visitValue(ValueTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitValue. Implements com.sun.source.doctree.DocTreeVisitor.visitValue. Visits a `ValueTree` node.
public Void	visitVersion(VersionTree tree, Void ignore) Overrides com.sun.source.util.DocTreeScanner.visitVersion. Implements com.sun.source.doctree.DocTreeVisitor.visitVersion. Visits a `VersionTree` node.
pack-priv void	warnIfEmpty(Checker.TagStackItem tsi, DocTree endTree)
pack-priv void	warnIfEmpty(DocTree tree, List<? extends DocTree> list)

Inherited from com.sun.source.util.DocTreePathScanner:: getCurrentPath scan

public Class Checker

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary