Package org.jdrupes.mdoclet.internal.doclets.toolkit

Klasse CommentUtils.DocCommentInfo

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.CommentUtils.DocCommentInfo

Umschließende Klasse:

CommentUtils

public static class CommentUtils.DocCommentInfo
extends Object

Info about a doc comment: the position in the enclosing AST, and the parsed doc comment itself.

The position in the AST is null for automatically generated comments, such as for Enum.values, Enum.valuesOf, and JavaFX properties.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final DocCommentTree	dcTree	The doc comment tree that is the root node of a parsed doc comment, or null if there is no comment.
final TreePath	treePath	The position of the comment in the enclosing AST, or null for automatically generated comments.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DocCommentInfo(TreePath treePath, DocCommentTree dcTree)

Methodenübersicht

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

treePath

public final TreePath treePath

The position of the comment in the enclosing AST, or null for automatically generated comments.

dcTree

public final DocCommentTree dcTree

The doc comment tree that is the root node of a parsed doc comment, or null if there is no comment.

Konstruktordetails

DocCommentInfo

public DocCommentInfo(TreePath treePath,
 DocCommentTree dcTree)