APIdia Launch Partner
Top Description Interfaces
module jdk.compiler

Package com.sun.source.doctree


Provides interfaces to represent documentation comments as abstract syntax trees (AST).
Since
1.8
External Specification
Documentation Comment Specification for the Standard Doclet

Interface Summary

Modifier and TypeInterface and Description
public interface
AttributeTree

A tree node for an attribute in an HTML element or tag.

public interface
AuthorTree

A tree node for an @author block tag.

public interface
BlockTagTree

A tree node used as the base class for the different types of block tags.

public interface
CommentTree

An embedded HTML comment.

public interface
DeprecatedTree

A tree node for an @deprecated block tag.

public interface
DocCommentTree

The top-level representation of a documentation comment.

public interface
DocRootTree

A tree node for an @docRoot inline tag.

public interface
DocTree

Common interface for all nodes in a documentation syntax tree.

public interface
DocTreeVisitor<
the return type of this visitor's methods. Use Void for visitors that do not need to return results.
R
,
the type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
P
>

A visitor of trees, in the style of the visitor design pattern.

public interface
DocTypeTree

A tree node for a doctype declaration.

public interface
EndElementTree

A tree node for the end of an HTML element.

public interface
EntityTree

A tree node for an HTML entity.

public interface
ErroneousTree

A tree node to stand in for malformed text.

public interface
EscapeTree

A tree node for a character represented by an escape sequence.

public interface
HiddenTree

A tree node for an @hidden block tag.

public interface
IdentifierTree

An identifier in a documentation comment.

public interface
IndexTree

A tree node for an @index inline tag.

public interface
InheritDocTree

A tree node for an @inheritDoc inline tag.

public interface
InlineTagTree

A tree node used as the base class for the different types of inline tags.

public interface
LinkTree

A tree node for an @link or @linkplain inline tag.

public interface
LiteralTree

A tree node for an @literal or @code inline tag.

public interface
ParamTree

A tree node for an @param block tag.

public interface
ProvidesTree

A tree node for a @provides block tag.

public interface
RawTextTree

A tree node for a fragment of uninterpreted raw text content.

public interface
ReferenceTree

A tree node for a reference to a Java language element.

public interface
ReturnTree

A tree node for an @return block tag.

public interface
SeeTree

A tree node for an @see block tag.

public interface
SerialDataTree

A tree node for an @serialData block tag.

public interface
SerialFieldTree

A tree node for an @serialField block tag.

public interface
SerialTree

A tree node for an @serial block tag.

public interface
SinceTree

A tree node for an @since block tag.

public interface
SnippetTree

A tree node for an @snippet inline tag.

public interface
SpecTree

A tree node for an @spec block tag.

public interface
StartElementTree

A tree node for the start of an HTML element.

public interface
SummaryTree

A tree node for an @summary inline tag.

public interface
SystemPropertyTree

A tree node for an @systemProperty inline tag.

public interface
TextTree

A tree node for plain text.

public interface
ThrowsTree

A tree node for an @exception or @throws block tag.

public interface
UnknownBlockTagTree

A tree node for an unrecognized block tag.

public interface
UnknownInlineTagTree

A tree node for an unrecognized inline tag.

public interface
UsesTree

A tree node for an @uses block tag.

public interface
ValueTree

A tree node for an @value inline tag.

public interface
VersionTree

A tree node for an @version block tag.