Uses of Interface com.sun.source.doctree.DocTree (Java SE 9 & JDK 9 )

Packages that use DocTree
软件包	描述
com.sun.source.doctree	提供用于将文档注释表示为抽象语法树（AST）的接口。
com.sun.source.util	为抽象语法树（AST）的操作提供实用程序。
jdk.javadoc.doclet	Doclet API提供了一个环境，结合语言模型API和编译器树API，客户端可以检查程序和库的源代码级结构，包括嵌入在源代码中的API注释。

Uses of DocTree in com.sun.source.doctree

Subinterfaces of DocTree in com.sun.source.doctree
Modifier and Type	接口	描述
`interface`	`AttributeTree`	HTML元素中属性的树节点。
`interface`	`AuthorTree`	@author块标记的树形节点。
`interface`	`BlockTagTree`	一个树节点用作不同类型的块标签的基类。
`interface`	`CommentTree`	嵌入式HTML注释。
`interface`	`DeprecatedTree`	@deprecated块标记的树节点。
`interface`	`DocCommentTree`	文档评论的顶级代表。
`interface`	`DocRootTree`	@docroot内联标记的树形节点。
`interface`	`EndElementTree`	用于HTML元素结尾的树节点。
`interface`	`EntityTree`	HTML实体的树节点。
`interface`	`ErroneousTree`	一个树状节点，用于生成格式不正确的文本
`interface`	`HiddenTree`	@hidden块标记的树节点。
`interface`	`IdentifierTree`	文档注释中的标识符。
`interface`	`IndexTree`	@index或@index内联标记的树形节点。
`interface`	`InheritDocTree`	@inheritDoc内联标记的树形节点。
`interface`	`InlineTagTree`	一个树节点用作不同类型的内联标签的基类。
`interface`	`LinkTree`	@link或@linkplain内联标记的树形节点。
`interface`	`LiteralTree`	@literal或@code内联标记的树状结点。
`interface`	`ParamTree`	@param块标记的树节点。
`interface`	`ProvidesTree`	@provides块标记的树节点。
`interface`	`ReferenceTree`	用于引用Java语言元素的树节点。
`interface`	`ReturnTree`	一个@return块标记的树节点。
`interface`	`SeeTree`	@see块标记的树节点。
`interface`	`SerialDataTree`	@serialData块标记的树节点。
`interface`	`SerialFieldTree`	@serialData块标记的树节点。
`interface`	`SerialTree`	@serial块标记的树节点。
`interface`	`SinceTree`	@since块标记的树节点。
`interface`	`StartElementTree`	用于开始HTML元素的树节点。
`interface`	`TextTree`	纯文本的树节点。
`interface`	`ThrowsTree`	@exception或@throws块标记的树节点。
`interface`	`UnknownBlockTagTree`	用于无法识别的内联标签的树节点。
`interface`	`UnknownInlineTagTree`	用于无法识别的内联标签的树节点。
`interface`	`UsesTree`	用于@uses块标记的树节点。
`interface`	`ValueTree`	@value内联标记的树形节点。
`interface`	`VersionTree`	用于@version块标记的树节点。

Methods in com.sun.source.doctree that return DocTree
Modifier and Type	方法	描述
`DocTree`	IndexTree.`getSearchTerm()`	返回指定的搜索项。

Methods in com.sun.source.doctree that return types with arguments of type DocTree
Modifier and Type	方法	描述
`List<? extends DocTree>`	StartElementTree.`getAttributes()`	返回此元素定义的任何属性。
`List<? extends DocTree>`	DocCommentTree.`getBlockTags()`	返回文档注释的块标签。
`List<? extends DocTree>`	DeprecatedTree.`getBody()`	返回解释为什么不推荐使用某项的描述。
`List<? extends DocTree>`	DocCommentTree.`getBody()`	返回文档注释的正文，出现在第一个句子之后，并返回任何块标记之前。
`List<? extends DocTree>`	HiddenTree.`getBody()`	返回说明为什么隐藏项目的描述。
`List<? extends DocTree>`	SinceTree.`getBody()`	返回说明正在记录的项目的可用性的文本。
`List<? extends DocTree>`	VersionTree.`getBody()`	返回标签的正文。
`List<? extends DocTree>`	UnknownBlockTagTree.`getContent()`	返回无法识别的块标签的内容。
`List<? extends DocTree>`	UnknownInlineTagTree.`getContent()`	返回无法识别的内联代码的内容。
`List<? extends DocTree>`	IndexTree.`getDescription()`	返回描述，如果有的话。
`List<? extends DocTree>`	ParamTree.`getDescription()`	返回参数的描述。
`List<? extends DocTree>`	ProvidesTree.`getDescription()`	返回由模块提供的服务类型的描述。
`List<? extends DocTree>`	ReturnTree.`getDescription()`	返回方法返回值的描述。
`List<? extends DocTree>`	SerialDataTree.`getDescription()`	返回串行数据的描述。
`List<? extends DocTree>`	SerialFieldTree.`getDescription()`	返回串行字段的描述。
`List<? extends DocTree>`	SerialTree.`getDescription()`	返回字段的描述，或返回“包含”或“排除”一词。
`List<? extends DocTree>`	ThrowsTree.`getDescription()`	返回说明可能抛出异常的原因。
`List<? extends DocTree>`	UsesTree.`getDescription()`	返回在模块中使用服务类型的描述。
`List<? extends DocTree>`	DocCommentTree.`getFirstSentence()`	返回文档注释的第一个句子。
`default List<? extends DocTree>`	DocCommentTree.`getFullBody()`	返回文档注释的整个正文，出现在任何块标记之前，包括第一个句子。
`List<? extends DocTree>`	LinkTree.`getLabel()`	返回链接的标签（如果有）。
`List<? extends DocTree>`	AuthorTree.`getName()`	返回作者的名称。
`List<? extends DocTree>`	SeeTree.`getReference()`	返回引用。
`List<? extends DocTree>`	AttributeTree.`getValue()`	返回属性的值，如果该类型为EMPTY，则返回 `null` 。

Methods in com.sun.source.doctree with parameters of type DocTree
Modifier and Type	方法	描述
`R`	DocTreeVisitor.`visitOther(DocTree node, P p)`	访问未知类型的DocTree节点。

Uses of DocTree in com.sun.source.util

Methods in com.sun.source.util that return DocTree
Modifier and Type	方法	描述
`DocTree`	DocTreePath.`getLeaf()`	返回此路径的叶节点。

Methods in com.sun.source.util that return types with arguments of type DocTree
Modifier and Type	方法	描述
`List<DocTree>`	DocTreeFactory.`getFirstSentence(List<? extends DocTree> list)`	获取内容列表中的第一个句子。
`abstract List<DocTree>`	DocTrees.`getFirstSentence(List<? extends DocTree> list)`	返回表示评论第一句的`DocTree`的列表。
`Iterator<DocTree>`	DocTreePath.`iterator()`

Methods in com.sun.source.util with parameters of type DocTree
Modifier and Type	方法	描述
`protected R`	SimpleDocTreeVisitor.`defaultAction(DocTree node, P p)`	所有访问方法使用的默认操作不被覆盖。
`long`	DocSourcePositions.`getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	返回文件中注释中树的结束位置。
`static DocTreePath`	DocTreePath.`getPath(DocTreePath path, DocTree target)`	返回由DocTreePath对象标识的子树内的树节点的文档树路径，如果未找到该节点，则 `null` 。
`static DocTreePath`	DocTreePath.`getPath(TreePath treePath, DocCommentTree doc, DocTree target)`	返回编译单元中树节点的文档树路径，如果未找到该节点，则 `null` 。
`long`	DocSourcePositions.`getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	返回文件内注释中树的起始位置。
`IndexTree`	DocTreeFactory.`newIndexTree(DocTree term, List<? extends DocTree> description)`	创建一个新的 `IndexTree`对象，以表示一个 `{@index }`标签。
`abstract void`	DocTrees.`printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)`	在提供的编译单元中的树的位置打印指定类型的消息
`R`	DocTreePathScanner.`scan(DocTree tree, P p)`	扫描单个节点。
`R`	DocTreeScanner.`scan(DocTree node, P p)`	扫描单个节点。
`R`	SimpleDocTreeVisitor.`visit(DocTree node, P p)`	调用特定于节点类型的适当访问方式。
`R`	DocTreeScanner.`visitOther(DocTree node, P p)`	访问未知类型的DocTree节点。
`R`	SimpleDocTreeVisitor.`visitOther(DocTree node, P p)`	访问未知类型的DocTree节点。

Method parameters in com.sun.source.util with type arguments of type DocTree
Modifier and Type	方法	描述
`List<DocTree>`	DocTreeFactory.`getFirstSentence(List<? extends DocTree> list)`	获取内容列表中的第一个句子。
`abstract List<DocTree>`	DocTrees.`getFirstSentence(List<? extends DocTree> list)`	返回表示评论第一句的`DocTree`的列表。
`AttributeTree`	DocTreeFactory.`newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)`	创建一个新的 `AttributeTree`对象，以表示HTML标签中的HTML属性。
`AuthorTree`	DocTreeFactory.`newAuthorTree(List<? extends DocTree> name)`	创建一个新的 `AuthorTree`对象，以表示一个 `{@author }`标签。
`DeprecatedTree`	DocTreeFactory.`newDeprecatedTree(List<? extends DocTree> text)`	创建一个新的 `DeprecatedTree`对象，以表示一个 `{@deprecated }`标签。
`DocCommentTree`	DocTreeFactory.`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)`	创建一个新的 `DocCommentTree`对象，以表示完整的文档注释。
`ThrowsTree`	DocTreeFactory.`newExceptionTree(ReferenceTree name, List<? extends DocTree> description)`	创建一个新的 `ExceptionTree`对象，以表示一个 `@exception`标签。
`HiddenTree`	DocTreeFactory.`newHiddenTree(List<? extends DocTree> text)`	创建一个新的 `HiddenTree`对象，以表示一个 `{@hidden }`标签。
`IndexTree`	DocTreeFactory.`newIndexTree(DocTree term, List<? extends DocTree> description)`	创建一个新的 `IndexTree`对象，以表示一个 `{@index }`标签。
`LinkTree`	DocTreeFactory.`newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)`	创建一个新的 `LinkPlainTree`对象，以表示一个 `{@linkplain }`标签。
`LinkTree`	DocTreeFactory.`newLinkTree(ReferenceTree ref, List<? extends DocTree> label)`	创建一个新的 `LinkTree`对象，以表示一个 `{@link }`标签。
`ParamTree`	DocTreeFactory.`newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)`	创建一个新的 `ParamTree`对象，以表示一个 `@param`标签。
`ProvidesTree`	DocTreeFactory.`newProvidesTree(ReferenceTree name, List<? extends DocTree> description)`	创建一个新的 `ProvidesTree`对象，以表示一个 `@provides`标签。
`ReturnTree`	DocTreeFactory.`newReturnTree(List<? extends DocTree> description)`	创建一个新的 `ReturnTree`对象，以表示一个 `@return`标签。
`SeeTree`	DocTreeFactory.`newSeeTree(List<? extends DocTree> reference)`	创建一个新的 `SeeTree`对象，以表示一个 `@see`标签。
`SerialDataTree`	DocTreeFactory.`newSerialDataTree(List<? extends DocTree> description)`	创建一个新的 `SerialDataTree`对象，代表一个 `@serialData`标签。
`SerialFieldTree`	DocTreeFactory.`newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)`	创建一个新的 `SerialFieldTree`对象，以表示一个 `@serialField`标签。
`SerialTree`	DocTreeFactory.`newSerialTree(List<? extends DocTree> description)`	创建一个新的 `SerialTree`对象，以表示一个 `@serial`标签。
`SinceTree`	DocTreeFactory.`newSinceTree(List<? extends DocTree> text)`	创建一个新的 `SinceTree`对象，以表示一个 `@since`标签。
`StartElementTree`	DocTreeFactory.`newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)`	创建一个新的 `StartElementTree`对象，以表示HTML元素的开始。
`ThrowsTree`	DocTreeFactory.`newThrowsTree(ReferenceTree name, List<? extends DocTree> description)`	创建一个新的 `ThrowsTree`对象，以表示一个 `@throws`标签。
`UnknownBlockTagTree`	DocTreeFactory.`newUnknownBlockTagTree(Name name, List<? extends DocTree> content)`	创建一个新的 `UnknownBlockTagTree`对象，以表示一个无法识别的块标签。
`UnknownInlineTagTree`	DocTreeFactory.`newUnknownInlineTagTree(Name name, List<? extends DocTree> content)`	创建一个新的 `UnknownInlineTagTree`对象，以表示无法识别的内联标签。
`UsesTree`	DocTreeFactory.`newUsesTree(ReferenceTree name, List<? extends DocTree> description)`	创建一个新的 `UsesTree`对象，代表一个 `@uses`标签。
`VersionTree`	DocTreeFactory.`newVersionTree(List<? extends DocTree> text)`	创建一个新的 `VersionTree`对象，以表示一个 `{@version }`标签。
`R`	DocTreeScanner.`scan(Iterable<? extends DocTree> nodes, P p)`	扫描一系列节点。
`R`	SimpleDocTreeVisitor.`visit(Iterable<? extends DocTree> nodes, P p)`	在每个节点序列上调用适当的访问方法。

Constructors in com.sun.source.util with parameters of type DocTree
Constructor	描述
`DocTreePath(DocTreePath p, DocTree t)`	为子节点创建DocTreePath。

Uses of DocTree in jdk.javadoc.doclet

Method parameters in jdk.javadoc.doclet with type arguments of type DocTree
Modifier and Type	方法	描述
`String`	Taglet.`toString(List<? extends DocTree> tags, Element element)`	返回要包含在生成的输出中的该标签的一系列实例的字符串表示形式。

Uses of Interfacecom.sun.source.doctree.DocTree

Uses of DocTree in com.sun.source.doctree

Uses of DocTree in com.sun.source.util

Uses of DocTree in jdk.javadoc.doclet

Uses of Interface
com.sun.source.doctree.DocTree