Modifier and Type	Class and Description
public static class	CommentUtils.DocCommentInfo Info about a doc comment: the position in the enclosing AST, and the parsed doc comment itself.

Modifier and Type	Field and Description
pack-priv final BaseConfiguration	configuration
pack-priv final HashMap<Element, CommentUtils.DocCommentInfo>	dcInfoMap A map for storing automatically generated comments for various elements, such as mandated elements (Enum.values, Enum.valueOf, etc) and JavaFX properties.
pack-priv final Elements	elementUtils
pack-priv final Resources	resources
pack-priv final DocTreeFactory	treeFactory
pack-priv final DocTrees	trees
pack-priv final Utils	utils

Access	Constructor and Description
protected	CommentUtils(BaseConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
private void	add(List<DocTree> contents, String resourceKey)
public List<? extends DocTree>	Returns: a list containing the string for a given key in the doclet's resources, formatted with given arguments getComment(String the key for the desired string key, Object string or DocTree argument to be formatted into the result o0) Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments.
public List<? extends DocTree>	Returns: a list containing the string for a given key in the doclet's resources, formatted with given arguments getComment(String the key for the desired strings key, Object string or a DocTree argument to be formatted into the result o0, Object string or a DocTree argument to be formatted into the result o1, Object string or a DocTree argument to be formatted into the result o2) Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments.
public CommentUtils.DocCommentInfo	getHtmlCommentInfo(Element e)
public CommentUtils.DocCommentInfo	getSyntheticCommentInfo(Element e)
private boolean	Returns: whether or not there is a `@param`} for the component hasParamForComponent(TypeElement the record element elem, Name the name of the component component) Returns whether or not the doc comment for a record contains an `@param`} for a state component of the record.
public LiteralTree	makeCodeTree(String text)
private List<DocTree>	Returns: the description makeDescriptionWithComponent(String the resource key for the description key, TypeElement the record element elem, Name the name of the component component) Creates a description that contains a reference to a state component of a record.
private List<DocTree>	Returns: the description makeDescriptionWithName(String the resource key for the description key, Name the name name) Creates a description that contains the simple name of a program element The description is looked up as a resource, and should contain `{0}` where the name is to be inserted.
public List<? extends DocTree>	makeFirstSentenceTree(String content)
public ParamTree	makeParamTree(Name name, List<? extends DocTree> description)
public List<? extends DocTree>	makePropertyDescriptionTree(List<? extends DocTree> content)
public ReturnTree	makeReturnTree(List<? extends DocTree> description)
public DocTree	makeSeeTree(String sig, Element e)
public TextTree	makeTextTree(String content)
public TextTree	makeTextTreeForResource(String key)
private List<DocTree>	Returns: the list of parsed `DocTree` nodes parse(String the string s) Parses a string, looking for simple embedded HTML.
public DocCommentTree	parse(URI uri, String text)
public CommentUtils.DocCommentInfo	setDocCommentInfo(Element element, CommentUtils.DocCommentInfo dci)
public CommentUtils.DocCommentInfo	setDocCommentTree(Element element, List<? extends DocTree> fullBody, List<? extends DocTree> blockTags)
public void	setEnumValueOfTree(ExecutableElement ee)
public void	setEnumValuesTree(ExecutableElement ee)
public void	setRecordAccessorTree(ExecutableElement the accessor method ee) Generates the description for the accessor method for a state component of a record.
public void	setRecordConstructorTree(ExecutableElement the constructor ee) Generates the description for the canonical constructor for a record.
public void	setRecordEqualsTree(ExecutableElement the `equals` method ee) Generates the description for the standard `equals` method for a record.
public void	setRecordFieldTree(VariableElement the field ve) Generates the description for the field for a state component of a record.
public void	setRecordHashCodeTree(ExecutableElement the `hashCode` method ee) Generates the description for the standard `hashCode` method for a record.
public void	setRecordToStringTree(ExecutableElement the `toString` method ee) Generates the description for the standard `toString` method for a record.
public void	updatePropertyMethodComment(ExecutableElement the member which is to be augmented member, Element the element containing the preferred property description property) Update the property method, property setter and/or property getter comment text so that it contains the documentation from the preferred property description (field or property method).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configuration	back to summary
pack-priv final BaseConfiguration configuration

dcInfoMap back to summary

dcInfoMap	back to summary
pack-priv final HashMap<Element, CommentUtils.DocCommentInfo> dcInfoMap A map for storing automatically generated comments for various elements, such as mandated elements (Enum.values, Enum.valueOf, etc) and JavaFX properties. See Also `Utils#dcTreeCache`

pack-priv final HashMap<Element, CommentUtils.DocCommentInfo> dcInfoMap

A map for storing automatically generated comments for various elements, such as mandated elements (Enum.values, Enum.valueOf, etc) and JavaFX properties.

See Also: Utils#dcTreeCache

elementUtils	back to summary
pack-priv final Elements elementUtils

resources	back to summary
pack-priv final Resources resources

treeFactory	back to summary
pack-priv final DocTreeFactory treeFactory

trees	back to summary
pack-priv final DocTrees trees

utils	back to summary
pack-priv final Utils utils

Constructor Detail

CommentUtils	back to summary
protected CommentUtils(BaseConfiguration configuration)

Method Detail

add	back to summary
private void add(List<DocTree> contents, String resourceKey)

getComment	back to summary
public List<? extends DocTree> getComment(String key, Object o0) Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments. Parameters key:String the key for the desired string o0:Object string or DocTree argument to be formatted into the result Returns:List<? extends DocTree> a list containing the string for a given key in the doclet's resources, formatted with given arguments

getComment

back to summary

public List<? extends DocTree> getComment(String key, Object o0)

Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments.

Parameters

key:String: the key for the desired string
o0:Object: string or DocTree argument to be formatted into the result

Returns:List<? extends DocTree>

a list containing the string for a given key in the doclet's resources, formatted with given arguments

getComment	back to summary
public List<? extends DocTree> getComment(String key, Object o0, Object o1, Object o2) Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments. Parameters key:String the key for the desired strings o0:Object string or a DocTree argument to be formatted into the result o1:Object string or a DocTree argument to be formatted into the result o2:Object string or a DocTree argument to be formatted into the result Returns:List<? extends DocTree> a list containing the string for a given key in the doclet's resources, formatted with given arguments

getComment

back to summary

public List<? extends DocTree> getComment(String key, Object o0, Object o1, Object o2)

Returns a list containing the string for a given key in the doclet's resources, formatted with given arguments.

Parameters

key:String: the key for the desired strings
o0:Object: string or a DocTree argument to be formatted into the result
o1:Object: string or a DocTree argument to be formatted into the result
o2:Object: string or a DocTree argument to be formatted into the result

Returns:List<? extends DocTree>

a list containing the string for a given key in the doclet's resources, formatted with given arguments

getHtmlCommentInfo	back to summary
public CommentUtils.DocCommentInfo getHtmlCommentInfo(Element e)

getSyntheticCommentInfo	back to summary
public CommentUtils.DocCommentInfo getSyntheticCommentInfo(Element e)

hasParamForComponent back to summary

hasParamForComponent	back to summary
private boolean hasParamForComponent(TypeElement elem, Name component) Returns whether or not the doc comment for a record contains an `@param`} for a state component of the record. Parameters elem:TypeElement the record element component:Name the name of the component Returns:boolean whether or not there is a `@param`} for the component

private boolean hasParamForComponent(TypeElement elem, Name component)

Returns whether or not the doc comment for a record contains an @param} for a state component of the record.

Parameters

elem:TypeElement: the record element
component:Name: the name of the component

Returns:boolean

whether or not there is a @param} for the component

makeCodeTree	back to summary
public LiteralTree makeCodeTree(String text)

makeDescriptionWithComponent back to summary

makeDescriptionWithComponent	back to summary
private List<DocTree> makeDescriptionWithComponent(String key, TypeElement elem, Name component) Creates a description that contains a reference to a state component of a record. The description is looked up as a resource, and should contain `{0}` where the reference to the component is to be inserted. The reference will be a link if the doc comment for the record has a `@param` tag for the component. Parameters key:String the resource key for the description elem:TypeElement the record element component:Name the name of the component Returns:List<DocTree> the description

private List<DocTree> makeDescriptionWithComponent(String key, TypeElement elem, Name component)

Creates a description that contains a reference to a state component of a record. The description is looked up as a resource, and should contain {0} where the reference to the component is to be inserted. The reference will be a link if the doc comment for the record has a @param tag for the component.

Parameters

key:String: the resource key for the description
elem:TypeElement: the record element
component:Name: the name of the component

Returns:List<DocTree>

the description

makeDescriptionWithName back to summary

makeDescriptionWithName	back to summary
private List<DocTree> makeDescriptionWithName(String key, Name name) Creates a description that contains the simple name of a program element The description is looked up as a resource, and should contain `{0}` where the name is to be inserted. Parameters key:String the resource key for the description name:Name the name Returns:List<DocTree> the description

private List<DocTree> makeDescriptionWithName(String key, Name name)

Creates a description that contains the simple name of a program element The description is looked up as a resource, and should contain {0} where the name is to be inserted.

Parameters

key:String: the resource key for the description
name:Name: the name

Returns:List<DocTree>

the description

makeFirstSentenceTree	back to summary
public List<? extends DocTree> makeFirstSentenceTree(String content)

makeParamTree	back to summary
public ParamTree makeParamTree(Name name, List<? extends DocTree> description)

makePropertyDescriptionTree	back to summary
public List<? extends DocTree> makePropertyDescriptionTree(List<? extends DocTree> content)

makeReturnTree	back to summary
public ReturnTree makeReturnTree(List<? extends DocTree> description)

makeSeeTree	back to summary
public DocTree makeSeeTree(String sig, Element e)

makeTextTree	back to summary
public TextTree makeTextTree(String content)

makeTextTreeForResource	back to summary
public TextTree makeTextTreeForResource(String key)

parse back to summary

parse	back to summary
private List<DocTree> parse(String s) Parses a string, looking for simple embedded HTML. Parameters s:String the string Returns:List<DocTree> the list of parsed `DocTree` nodes

private List<DocTree> parse(String s)

Parses a string, looking for simple embedded HTML.

Parameters

s:String: the string

Returns:List<DocTree>

the list of parsed DocTree nodes

parse	back to summary
public DocCommentTree parse(URI uri, String text)

setDocCommentInfo	back to summary
public CommentUtils.DocCommentInfo setDocCommentInfo(Element element, CommentUtils.DocCommentInfo dci)

setDocCommentTree	back to summary
public CommentUtils.DocCommentInfo setDocCommentTree(Element element, List<? extends DocTree> fullBody, List<? extends DocTree> blockTags)

setEnumValueOfTree	back to summary
public void setEnumValueOfTree(ExecutableElement ee)

setEnumValuesTree	back to summary
public void setEnumValuesTree(ExecutableElement ee)

setRecordAccessorTree	back to summary
public void setRecordAccessorTree(ExecutableElement ee) Generates the description for the accessor method for a state component of a record. Parameters ee:ExecutableElement the accessor method

setRecordAccessorTree

back to summary

public void setRecordAccessorTree(ExecutableElement ee)

Generates the description for the accessor method for a state component of a record.

Parameters

ee:ExecutableElement: the accessor method

setRecordConstructorTree	back to summary
public void setRecordConstructorTree(ExecutableElement ee) Generates the description for the canonical constructor for a record. Parameters ee:ExecutableElement the constructor

setRecordConstructorTree

back to summary

public void setRecordConstructorTree(ExecutableElement ee)

Generates the description for the canonical constructor for a record.

Parameters

ee:ExecutableElement: the constructor

setRecordEqualsTree back to summary

setRecordEqualsTree	back to summary
public void setRecordEqualsTree(ExecutableElement ee) Generates the description for the standard `equals` method for a record. Parameters ee:ExecutableElement the `equals` method

public void setRecordEqualsTree(ExecutableElement ee)

Generates the description for the standard equals method for a record.

Parameters

ee:ExecutableElement: the equals method

setRecordFieldTree	back to summary
public void setRecordFieldTree(VariableElement ve) Generates the description for the field for a state component of a record. Parameters ve:VariableElement the field

setRecordFieldTree

back to summary

public void setRecordFieldTree(VariableElement ve)

Generates the description for the field for a state component of a record.

Parameters

ve:VariableElement: the field

setRecordHashCodeTree back to summary

setRecordHashCodeTree	back to summary
public void setRecordHashCodeTree(ExecutableElement ee) Generates the description for the standard `hashCode` method for a record. Parameters ee:ExecutableElement the `hashCode` method

public void setRecordHashCodeTree(ExecutableElement ee)

Generates the description for the standard hashCode method for a record.

Parameters

ee:ExecutableElement: the hashCode method

setRecordToStringTree back to summary

setRecordToStringTree	back to summary
public void setRecordToStringTree(ExecutableElement ee) Generates the description for the standard `toString` method for a record. Parameters ee:ExecutableElement the `toString` method

public void setRecordToStringTree(ExecutableElement ee)

Generates the description for the standard toString method for a record.

Parameters

ee:ExecutableElement: the toString method

updatePropertyMethodComment back to summary

updatePropertyMethodComment	back to summary
public void updatePropertyMethodComment(ExecutableElement member, Element property) Update the property method, property setter and/or property getter comment text so that it contains the documentation from the preferred property description (field or property method). The method adds the leading sentence, copied documentation including the defaultValue tag and the `@see` tags if the appropriate methods are available. Parameters member:ExecutableElement the member which is to be augmented property:Element the element containing the preferred property description

public void updatePropertyMethodComment(ExecutableElement member, Element property)

Update the property method, property setter and/or property getter comment text so that it contains the documentation from the preferred property description (field or property method). The method adds the leading sentence, copied documentation including the defaultValue tag and the @see tags if the appropriate methods are available.

Parameters

member:ExecutableElement: the member which is to be augmented
property:Element: the element containing the preferred property description

jdk.javadoc.internal.doclets.toolkit back to summary

public Class CommentUtils.DocCommentInfo

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.CommentUtils.DocCommentInfo

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.

Field Summary

Modifier and Type	Field and Description
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.
public final TreePath	treePath The position of the comment in the enclosing AST, or `null` for automatically generated comments.

Constructor Summary

Access	Constructor and Description
public	DocCommentInfo(TreePath treePath, DocCommentTree dcTree)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dcTree	back to summary
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.

treePath	back to summary
public final TreePath treePath The position of the comment in the enclosing AST, or `null` for automatically generated comments.

Constructor Detail

DocCommentInfo	back to summary
public DocCommentInfo(TreePath treePath, DocCommentTree dcTree)

public Class CommentUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CommentUtils.DocCommentInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail