Uses of Interface
com.sun.source.doctree.DocTree
-
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 变量和类型 接口 描述 interface
AttributeTree
HTML元素中属性的树节点。interface
AuthorTree
@author块标记的树节点。interface
BlockTagTree
一个树节点,用作不同类型块标记的基类。interface
CommentTree
嵌入式HTML评论。interface
DeprecatedTree
@deprecated块标记的树节点。interface
DocCommentTree
文档注释的顶级表示。interface
DocRootTree
@docroot内联标记的树节点。interface
DocTypeTree
doctype
声明的树节点。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
SummaryTree
@summary内联标记的树节点。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 变量和类型 方法 描述 DocTree
IndexTree. getSearchTerm()
返回指定的搜索词。Methods in com.sun.source.doctree that return types with arguments of type DocTree 变量和类型 方法 描述 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()
返回字段的描述,或单词“include”或“exclude”。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()
返回作者的姓名。default List<? extends DocTree>
DocCommentTree. getPostamble()
返回包含文档注释内容之后的内容(如果有)的树的列表。default List<? extends DocTree>
DocCommentTree. getPreamble()
返回包含文档注释内容之前的内容(如果有)的树的列表。List<? extends DocTree>
SeeTree. getReference()
返回引用。List<? extends DocTree>
SummaryTree. getSummary()
返回注释的摘要或第一行。List<? extends DocTree>
AttributeTree. getValue()
返回属性的值,如果类型为EMPTY,则返回null
。Methods in com.sun.source.doctree with parameters of type DocTree 变量和类型 方法 描述 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 变量和类型 方法 描述 DocTree
DocTreePath. getLeaf()
返回此路径的叶节点。Methods in com.sun.source.util that return types with arguments of type DocTree 变量和类型 方法 描述 List<DocTree>
DocTreeFactory. getFirstSentence(List<? extends DocTree> list)
获取内容列表中包含的第一个句子。abstract List<DocTree>
DocTrees. getFirstSentence(List<? extends DocTree> list)
返回表示注释的第一个句子的DocTree
的列表。Methods in com.sun.source.util with parameters of type DocTree 变量和类型 方法 描述 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 变量和类型 方法 描述 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
对象,以表示完整的文档注释。DocCommentTree
DocTreeFactory. newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)
创建一个新的DocCommentTree
对象,以表示enitire doc注释。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元素的开头。default SummaryTree
DocTreeFactory. newSummaryTree(List<? extends DocTree> summary)
创建一个新的SummaryTree
对象,以表示@summary
标记。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 构造器 描述 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 变量和类型 方法 描述 String
Taglet. toString(List<? extends DocTree> tags, Element element)
返回要包含在生成的输出中的此标记的一系列实例的字符串表示形式。
-