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

Klasse CommentUtils

java.lang.Object

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

public class CommentUtils
extends Object

A utility class for handling documentation comments.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	CommentUtils.DocCommentInfo	Info about a doc comment: the position in the enclosing AST, and the parsed doc comment itself.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	CommentUtils(BaseConfiguration configuration)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<? extends DocTree>	getComment(String key, Object o0)	Gibt a list containing the string for a given key in the doclet's resources, formatted with given arguments zurück.
List<? extends DocTree>	getComment(String key, Object o0, Object o1, Object o2)	Gibt a list containing the string for a given key in the doclet's resources, formatted with given arguments zurück.
CommentUtils.DocCommentInfo	getHtmlCommentInfo(Element e)
CommentUtils.DocCommentInfo	getSyntheticCommentInfo(Element e)
LiteralTree	makeCodeTree(String text)
List<? extends DocTree>	makeFirstSentenceTree(String content)
ParamTree	makeParamTree(Name name, List<? extends DocTree> description)
List<? extends DocTree>	makePropertyDescriptionTree(List<? extends DocTree> content)
ReturnTree	makeReturnTree(List<? extends DocTree> description)
DocTree	makeSeeTree(String sig, Element e)
TextTree	makeTextTree(String content)
TextTree	makeTextTreeForResource(String key)
DocCommentTree	parse(URI uri, String text)
CommentUtils.DocCommentInfo	setDocCommentInfo(Element element, CommentUtils.DocCommentInfo dci)
CommentUtils.DocCommentInfo	setDocCommentTree(Element element, List<? extends DocTree> fullBody, List<? extends DocTree> blockTags)
void	setEnumValueOfTree(ExecutableElement ee)
void	setEnumValuesTree(ExecutableElement ee)
void	setRecordAccessorTree(ExecutableElement ee)	Generates the description for the accessor method for a state component of a record.
void	setRecordConstructorTree(ExecutableElement ee)	Generates the description for the canonical constructor for a record.
void	setRecordEqualsTree(ExecutableElement ee)	Generates the description for the standard equals method for a record.
void	setRecordFieldTree(VariableElement ve)	Generates the description for the field for a state component of a record.
void	setRecordHashCodeTree(ExecutableElement ee)	Generates the description for the standard hashCode method for a record.
void	setRecordToStringTree(ExecutableElement ee)	Generates the description for the standard toString method for a record.
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).

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

CommentUtils

protected CommentUtils(BaseConfiguration configuration)

Methodendetails

makePropertyDescriptionTree

public List<? extends DocTree> makePropertyDescriptionTree(List<? extends DocTree> content)

makeCodeTree

public LiteralTree makeCodeTree(String text)

makeFirstSentenceTree

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

makeParamTree

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

makeReturnTree

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

makeSeeTree

public DocTree makeSeeTree(String sig,
 Element e)

makeTextTree

public TextTree makeTextTree(String content)

makeTextTreeForResource

public TextTree makeTextTreeForResource(String key)

setEnumValuesTree

public void setEnumValuesTree(ExecutableElement ee)

setEnumValueOfTree

public void setEnumValueOfTree(ExecutableElement ee)

setRecordConstructorTree

public void setRecordConstructorTree(ExecutableElement ee)

Generates the description for the canonical constructor for a record.

Parameter:

ee - the constructor

setRecordEqualsTree

public void setRecordEqualsTree(ExecutableElement ee)

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

Parameter:

ee - the equals method

setRecordHashCodeTree

public void setRecordHashCodeTree(ExecutableElement ee)

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

Parameter:

ee - the hashCode method

setRecordToStringTree

public void setRecordToStringTree(ExecutableElement ee)

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

Parameter:

ee - the toString method

setRecordAccessorTree

public void setRecordAccessorTree(ExecutableElement ee)

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

Parameter:

ee - the accessor method

setRecordFieldTree

public void setRecordFieldTree(VariableElement ve)

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

Parameter:

ve - the field

updatePropertyMethodComment

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.

Parameter:

member - the member which is to be augmented

property - the element containing the preferred property description

getComment

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

Gibt a list containing the string for a given key in the doclet's resources, formatted with given arguments zurück.

Parameter:

key - the key for the desired string

o0 - string or DocTree argument to be formatted into the result

Gibt zurück:

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

getComment

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

Gibt a list containing the string for a given key in the doclet's resources, formatted with given arguments zurück.

Parameter:

key - the key for the desired strings

o0 - string or a DocTree argument to be formatted into the result

o1 - string or a DocTree argument to be formatted into the result

o2 - string or a DocTree argument to be formatted into the result

Gibt zurück:

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

getSyntheticCommentInfo

public CommentUtils.DocCommentInfo getSyntheticCommentInfo(Element e)

getHtmlCommentInfo

public CommentUtils.DocCommentInfo getHtmlCommentInfo(Element e)

parse

public DocCommentTree parse(URI uri,
 String text)

setDocCommentTree

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

setDocCommentInfo

public CommentUtils.DocCommentInfo setDocCommentInfo(Element element,
 CommentUtils.DocCommentInfo dci)