Uses of Interface
com.sun.source.doctree.DocTree
Packages that use DocTree
Package
Description
Provides interfaces to represent documentation comments as abstract syntax
trees (AST).
Provides utilities for operations on abstract syntax trees (AST).
The Doclet API provides an environment which, in conjunction with
the Language Model API and Compiler Tree API, allows clients
to inspect the source-level structures of programs and
libraries, including API comments embedded in the source.
-
Uses of DocTree in com.sun.source.doctree
Subinterfaces of DocTree in com.sun.source.doctreeModifier and TypeInterfaceDescriptioninterfaceA tree node for an attribute in an HTML element.interfaceA tree node for an@authorblock tag.interfaceA tree node used as the base class for the different types of block tags.interfaceAn embedded HTML comment.interfaceA tree node for an@deprecatedblock tag.interfaceThe top-level representation of a documentation comment.interfaceA tree node for an@docRootinline tag.interfaceA tree node for adoctypedeclaration.interfaceA tree node for the end of an HTML element.interfaceA tree node for an HTML entity.interfaceA tree node to stand in for malformed text.interfaceA tree node for an@hiddenblock tag.interfaceAn identifier in a documentation comment.interfaceA tree node for an@indexinline tag.interfaceA tree node for an@inheritDocinline tag.interfaceA tree node used as the base class for the different types of inline tags.interfaceA tree node for an@linkor@linkplaininline tag.interfaceA tree node for an@literalor@codeinline tag.interfaceA tree node for an@paramblock tag.interfaceA tree node for a@providesblock tag.interfaceA tree node for a reference to a Java language element.interfaceA tree node for an@returnblock tag.interfaceA tree node for an@seeblock tag.interfaceA tree node for an@serialDatablock tag.interfaceA tree node for an@serialFieldblock tag.interfaceA tree node for an@serialblock tag.interfaceA tree node for an@sinceblock tag.interfaceA tree node for the start of an HTML element.interfaceA tree node for an@summaryinline tag.interfaceA tree node for an@systemPropertyinline tag.interfaceA tree node for plain text.interfaceA tree node for an@exceptionor@throwsblock tag.interfaceA tree node for an unrecognized block tag.interfaceA tree node for an unrecognized inline tag.interfaceA tree node for an@usesblock tag.interfaceA tree node for an@valueinline tag.interfaceA tree node for an@versionblock tag.Methods in com.sun.source.doctree that return DocTreeMethods in com.sun.source.doctree that return types with arguments of type DocTreeModifier and TypeMethodDescriptionStartElementTree.getAttributes()Returns any attributes defined by this element.DocCommentTree.getBlockTags()Returns the block tags for a documentation comment.DeprecatedTree.getBody()Returns the description explaining why an item is deprecated.DocCommentTree.getBody()Returns the body of a documentation comment, appearing after the first sentence, and before any block tags.HiddenTree.getBody()Returns the description explaining why an item is hidden.SinceTree.getBody()Returns the text explaining the availability of the item being documented.VersionTree.getBody()Returns the body of the tag.UnknownBlockTagTree.getContent()Returns the content of an unrecognized block tag.UnknownInlineTagTree.getContent()Returns the content of an unrecognized inline tag.IndexTree.getDescription()Returns the description, if any.ParamTree.getDescription()Returns the description of the parameter.ProvidesTree.getDescription()Returns a description of the service type being provided by the module.ReturnTree.getDescription()Returns the description of the return value of a method.SerialDataTree.getDescription()Returns the description of the serial data.SerialFieldTree.getDescription()Returns the description of the serial field.SerialTree.getDescription()Returns the description of the field, or the word "include" or "exclude".ThrowsTree.getDescription()Returns a description of the reasons why the exception may be thrown.UsesTree.getDescription()Returns a description of the use of service type within the module.DocCommentTree.getFirstSentence()Returns the first sentence of a documentation comment.DocCommentTree.getFullBody()Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence.LinkTree.getLabel()Returns the label, if any, of the link.AuthorTree.getName()Returns the name of the author.DocCommentTree.getPostamble()Returns a list of trees containing the content (if any) following the content of the documentation comment.DocCommentTree.getPreamble()Returns a list of trees containing the content (if any) preceding the content of the documentation comment.SeeTree.getReference()Returns the reference.SummaryTree.getSummary()Returns the summary or the first line of a comment.AttributeTree.getValue()Methods in com.sun.source.doctree with parameters of type DocTreeModifier and TypeMethodDescriptionDocTreeVisitor.visitOther(DocTree node, P p) Visits an unknown type of DocTree node. -
Uses of DocTree in com.sun.source.util
Methods in com.sun.source.util that return DocTreeMethods in com.sun.source.util that return types with arguments of type DocTreeModifier and TypeMethodDescriptionDocTreeFactory.getFirstSentence(List<? extends DocTree> list) Gets the first sentence contained in a list of content.DocTrees.getFirstSentence(List<? extends DocTree> list) Returns the list ofDocTreerepresenting the first sentence of a comment.DocTreePath.iterator()Methods in com.sun.source.util with parameters of type DocTreeModifier and TypeMethodDescriptionprotected RSimpleDocTreeVisitor.defaultAction(DocTree node, P p) The default action, used by all visit methods that are not overridden.longDocSourcePositions.getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Returns the ending position of the tree within the comment within the file.static DocTreePathDocTreePath.getPath(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by aDocTreePathobject, ornullif the node is not found.static DocTreePathDocTreePath.getPath(TreePath treePath, DocCommentTree doc, DocTree target) Returns a documentation tree path for a tree node within a compilation unit, ornullif the node is not found.longDocSourcePositions.getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Returns the starting position of the tree within the comment within the file.DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description) Creates a newIndexTreeobject, to represent an{@index }tag.abstract voidDocTrees.printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) Prints a message of the specified kind at the location of the tree within the provided compilation unitScans a single node.Scans a single node.final RInvokes the appropriate visit method specific to the type of the node.DocTreeScanner.visitOther(DocTree node, P p) Visits an unknown type of DocTree node.SimpleDocTreeVisitor.visitOther(DocTree node, P p) Visits an unknown type of DocTree node.Method parameters in com.sun.source.util with type arguments of type DocTreeModifier and TypeMethodDescriptionDocTreeFactory.getFirstSentence(List<? extends DocTree> list) Gets the first sentence contained in a list of content.DocTrees.getFirstSentence(List<? extends DocTree> list) Returns the list ofDocTreerepresenting the first sentence of a comment.DocTreeFactory.newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) Creates a newAttributeTreeobject, to represent an HTML attribute in an HTML tag.DocTreeFactory.newAuthorTree(List<? extends DocTree> name) Creates a newAuthorTreeobject, to represent an@authortag.DocTreeFactory.newDeprecatedTree(List<? extends DocTree> text) Creates a newDeprecatedTreeobject, to represent an@deprecatedtag.DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) Creates a newDocCommentTreeobject, to represent a complete doc comment.DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) Creates a newDocCommentTreeobject, to represent the entire doc comment.DocTreeFactory.newExceptionTree(ReferenceTree name, List<? extends DocTree> description) Creates a newThrowsTreeobject, to represent an@exceptiontag.DocTreeFactory.newHiddenTree(List<? extends DocTree> text) Creates a newHiddenTreeobject, to represent an@hiddentag.DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description) Creates a newIndexTreeobject, to represent an{@index }tag.DocTreeFactory.newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) Creates a newLinkTreeobject, to represent a{@linkplain }tag.DocTreeFactory.newLinkTree(ReferenceTree ref, List<? extends DocTree> label) Creates a newLinkTreeobject, to represent a{@link }tag.DocTreeFactory.newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) Creates a newParamTreeobject, to represent a@paramtag.DocTreeFactory.newProvidesTree(ReferenceTree name, List<? extends DocTree> description) Creates a newProvidesTreeobject, to represent a@providestag.default ReturnTreeDocTreeFactory.newReturnTree(boolean isInline, List<? extends DocTree> description) Creates a newReturnTreeobject, to represent a@returntag or{@return}tag.DocTreeFactory.newReturnTree(List<? extends DocTree> description) Creates a newReturnTreeobject, to represent a@returntag.DocTreeFactory.newSeeTree(List<? extends DocTree> reference) Creates a newSeeTreeobject, to represent a@seetag.DocTreeFactory.newSerialDataTree(List<? extends DocTree> description) Creates a newSerialDataTreeobject, to represent a@serialDatatag.DocTreeFactory.newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) Creates a newSerialFieldTreeobject, to represent a@serialFieldtag.DocTreeFactory.newSerialTree(List<? extends DocTree> description) Creates a newSerialTreeobject, to represent a@serialtag.DocTreeFactory.newSinceTree(List<? extends DocTree> text) Creates a newSinceTreeobject, to represent a@sincetag.DocTreeFactory.newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) Creates a newStartElementTreeobject, to represent the start of an HTML element.default SummaryTreeDocTreeFactory.newSummaryTree(List<? extends DocTree> summary) Creates a newSummaryTreeobject, to represent a{@summary }tag.DocTreeFactory.newThrowsTree(ReferenceTree name, List<? extends DocTree> description) Creates a newThrowsTreeobject, to represent a@throwstag.DocTreeFactory.newUnknownBlockTagTree(Name name, List<? extends DocTree> content) Creates a newUnknownBlockTagTreeobject, to represent an unrecognized block tag.DocTreeFactory.newUnknownInlineTagTree(Name name, List<? extends DocTree> content) Creates a newUnknownInlineTagTreeobject, to represent an unrecognized inline tag.DocTreeFactory.newUsesTree(ReferenceTree name, List<? extends DocTree> description) Creates a newUsesTreeobject, to represent a@usestag.DocTreeFactory.newVersionTree(List<? extends DocTree> text) Creates a newVersionTreeobject, to represent a{@version }tag.Scans a sequence of nodes.final RInvokes the appropriate visit method on each of a sequence of nodes.Constructors in com.sun.source.util with parameters of type DocTreeModifierConstructorDescriptionDocTreePath(DocTreePath p, DocTree t) Creates aDocTreePathfor a child node. -
Uses of DocTree in jdk.javadoc.doclet
Method parameters in jdk.javadoc.doclet with type arguments of type DocTree