Package com.sun.tools.doclint

Class Checker

java.lang.Object

com.sun.source.util.DocTreeScanner<R,P>

com.sun.source.util.DocTreePathScanner<Void,Void>

com.sun.tools.doclint.Checker

All Implemented Interfaces:

DocTreeVisitor<Void,Void>

public class Checker
extends DocTreePathScanner<Void,Void>

Validate a doc comment.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Checker.Flag

Method Summary

Modifier and Type	Method and Description
Void	scan(DocCommentTree tree, TreePath p)
Void	visitAttribute(AttributeTree tree, Void ignore)
Void	visitAuthor(AuthorTree tree, Void ignore)
Void	visitDocComment(DocCommentTree tree, Void ignore)
Void	visitDocRoot(DocRootTree tree, Void ignore)
Void	visitEndElement(EndElementTree tree, Void ignore)
Void	visitEntity(EntityTree tree, Void ignore)
Void	visitErroneous(ErroneousTree tree, Void ignore)
Void	visitInheritDoc(InheritDocTree tree, Void ignore)
Void	visitLink(LinkTree tree, Void ignore)
Void	visitLiteral(LiteralTree tree, Void ignore)
Void	visitParam(ParamTree tree, Void ignore)
Void	visitReference(ReferenceTree tree, Void ignore)
Void	visitReturn(ReturnTree tree, Void ignore)
Void	visitSerialData(SerialDataTree tree, Void ignore)
Void	visitSerialField(SerialFieldTree tree, Void ignore)
Void	visitSince(SinceTree tree, Void ignore)
Void	visitStartElement(StartElementTree tree, Void ignore)
Void	visitText(TextTree tree, Void ignore)
Void	visitThrows(ThrowsTree tree, Void ignore)
Void	visitUnknownBlockTag(UnknownBlockTagTree tree, Void ignore)
Void	visitUnknownInlineTag(UnknownInlineTagTree tree, Void ignore)
Void	visitValue(ValueTree tree, Void ignore)
Void	visitVersion(VersionTree tree, Void ignore)

Methods inherited from class com.sun.source.util.DocTreePathScanner

getCurrentPath, scan, scan

Methods inherited from class com.sun.source.util.DocTreeScanner

reduce, scan, visitComment, visitDeprecated, visitIdentifier, visitOther, visitSee, visitSerial

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

scan

public Void scan(DocCommentTree tree,
                 TreePath p)

visitDocComment

public Void visitDocComment(DocCommentTree tree,
                            Void ignore)

Specified by:

visitDocComment in interface DocTreeVisitor<Void,Void>

Overrides:

visitDocComment in class DocTreeScanner<Void,Void>

visitText

public Void visitText(TextTree tree,
                      Void ignore)

Specified by:

visitText in interface DocTreeVisitor<Void,Void>

Overrides:

visitText in class DocTreeScanner<Void,Void>

visitEntity

public Void visitEntity(EntityTree tree,
                        Void ignore)

Specified by:

visitEntity in interface DocTreeVisitor<Void,Void>

Overrides:

visitEntity in class DocTreeScanner<Void,Void>

visitStartElement

public Void visitStartElement(StartElementTree tree,
                              Void ignore)

Specified by:

visitStartElement in interface DocTreeVisitor<Void,Void>

Overrides:

visitStartElement in class DocTreeScanner<Void,Void>

visitEndElement

public Void visitEndElement(EndElementTree tree,
                            Void ignore)

Specified by:

visitEndElement in interface DocTreeVisitor<Void,Void>

Overrides:

visitEndElement in class DocTreeScanner<Void,Void>

visitAttribute

public Void visitAttribute(AttributeTree tree,
                           Void ignore)

Specified by:

visitAttribute in interface DocTreeVisitor<Void,Void>

Overrides:

visitAttribute in class DocTreeScanner<Void,Void>

visitAuthor

public Void visitAuthor(AuthorTree tree,
                        Void ignore)

Specified by:

visitAuthor in interface DocTreeVisitor<Void,Void>

Overrides:

visitAuthor in class DocTreeScanner<Void,Void>

visitDocRoot

public Void visitDocRoot(DocRootTree tree,
                         Void ignore)

Specified by:

visitDocRoot in interface DocTreeVisitor<Void,Void>

Overrides:

visitDocRoot in class DocTreeScanner<Void,Void>

visitInheritDoc

public Void visitInheritDoc(InheritDocTree tree,
                            Void ignore)

Specified by:

visitInheritDoc in interface DocTreeVisitor<Void,Void>

Overrides:

visitInheritDoc in class DocTreeScanner<Void,Void>

visitLink

public Void visitLink(LinkTree tree,
                      Void ignore)

Specified by:

visitLink in interface DocTreeVisitor<Void,Void>

Overrides:

visitLink in class DocTreeScanner<Void,Void>

visitLiteral

public Void visitLiteral(LiteralTree tree,
                         Void ignore)

Specified by:

visitLiteral in interface DocTreeVisitor<Void,Void>

Overrides:

visitLiteral in class DocTreeScanner<Void,Void>

visitParam

public Void visitParam(ParamTree tree,
                       Void ignore)

Specified by:

visitParam in interface DocTreeVisitor<Void,Void>

Overrides:

visitParam in class DocTreeScanner<Void,Void>

visitReference

public Void visitReference(ReferenceTree tree,
                           Void ignore)

Specified by:

visitReference in interface DocTreeVisitor<Void,Void>

Overrides:

visitReference in class DocTreeScanner<Void,Void>

visitReturn

public Void visitReturn(ReturnTree tree,
                        Void ignore)

Specified by:

visitReturn in interface DocTreeVisitor<Void,Void>

Overrides:

visitReturn in class DocTreeScanner<Void,Void>

visitSerialData

public Void visitSerialData(SerialDataTree tree,
                            Void ignore)

Specified by:

visitSerialData in interface DocTreeVisitor<Void,Void>

Overrides:

visitSerialData in class DocTreeScanner<Void,Void>

visitSerialField

public Void visitSerialField(SerialFieldTree tree,
                             Void ignore)

Specified by:

visitSerialField in interface DocTreeVisitor<Void,Void>

Overrides:

visitSerialField in class DocTreeScanner<Void,Void>

visitSince

public Void visitSince(SinceTree tree,
                       Void ignore)

Specified by:

visitSince in interface DocTreeVisitor<Void,Void>

Overrides:

visitSince in class DocTreeScanner<Void,Void>

visitThrows

public Void visitThrows(ThrowsTree tree,
                        Void ignore)

Specified by:

visitThrows in interface DocTreeVisitor<Void,Void>

Overrides:

visitThrows in class DocTreeScanner<Void,Void>

visitUnknownBlockTag

public Void visitUnknownBlockTag(UnknownBlockTagTree tree,
                                 Void ignore)

Specified by:

visitUnknownBlockTag in interface DocTreeVisitor<Void,Void>

Overrides:

visitUnknownBlockTag in class DocTreeScanner<Void,Void>

visitUnknownInlineTag

public Void visitUnknownInlineTag(UnknownInlineTagTree tree,
                                  Void ignore)

Specified by:

visitUnknownInlineTag in interface DocTreeVisitor<Void,Void>

Overrides:

visitUnknownInlineTag in class DocTreeScanner<Void,Void>

visitValue

public Void visitValue(ValueTree tree,
                       Void ignore)

Specified by:

visitValue in interface DocTreeVisitor<Void,Void>

Overrides:

visitValue in class DocTreeScanner<Void,Void>

visitVersion

public Void visitVersion(VersionTree tree,
                         Void ignore)

Specified by:

visitVersion in interface DocTreeVisitor<Void,Void>

Overrides:

visitVersion in class DocTreeScanner<Void,Void>

visitErroneous

public Void visitErroneous(ErroneousTree tree,
                           Void ignore)

Specified by:

visitErroneous in interface DocTreeVisitor<Void,Void>

Overrides:

visitErroneous in class DocTreeScanner<Void,Void>