public interface JComment
Modifier and Type | Method and Description |
---|---|
JComment |
block()
Add a comment sub-block at this location.
|
JComment |
code()
Add an inline code tag.
|
JComment |
docRoot()
Add the
{@docRoot} tag at this position. |
JComment |
inlineDocTag(String tag)
Add an inline doc tag.
|
JComment |
inlineDocTag(String tag,
String body)
Add an inline doc tag with simple content.
|
JComment |
linkConstructor(boolean plain,
JType targetType,
JType... targetConstructorArgumentTypes)
Add an inline
@link to a constructor. |
JComment |
linkField(boolean plain,
JType targetType,
String targetField)
Add an inline
@link to a field of a type. |
JComment |
linkMethod(boolean plain,
JMethodDef methodDef)
Add an inline
@link to a method. |
JComment |
linkMethod(boolean plain,
JType targetType,
String targetMethod,
JType... targetMethodArgumentTypes)
Add an inline
@link to a method. |
JComment |
linkType(boolean plain,
JType targetType)
Add an inline
@link to a type. |
JComment |
nl()
Add a newline.
|
JComment |
sp()
Add a non-trailing space.
|
JComment |
text(String text)
Add some text to the end of this comment.
|
JComment |
typeName(JType type)
Add a type name to the end of this comment.
|
JComment text(String text)
text
- the text to addJComment sp()
JComment nl()
JComment typeName(JType type)
type
- the type name to addJComment block()
JComment inlineDocTag(String tag, String body)
tag
- the tag name (without the leading @
sign)body
- the complete tag bodyJComment inlineDocTag(String tag)
tag
- the tag name (without the leading @
sign)JComment code()
JComment docRoot()
{@docRoot}
tag at this position.JComment linkType(boolean plain, JType targetType)
@link
to a type.plain
- true
to render in plain font, false
to render in monospace
fonttargetType
- the target type to link toJComment linkField(boolean plain, JType targetType, String targetField)
@link
to a field of a type.plain
- true
to render in plain font, false
to render in monospace
fonttargetType
- the target type to link totargetField
- the target field to link toJComment linkConstructor(boolean plain, JType targetType, JType... targetConstructorArgumentTypes)
@link
to a constructor.plain
- true
to render in plain font, false
to render in monospace
fonttargetType
- the target type to link totargetConstructorArgumentTypes
- the argument types of the constructor to link toJComment linkMethod(boolean plain, JType targetType, String targetMethod, JType... targetMethodArgumentTypes)
@link
to a method.plain
- true
to render in plain font, false
to render in monospace
fonttargetType
- the target type to link totargetMethod
- the name of the method to link totargetMethodArgumentTypes
- the argument types of the method to link toJComment linkMethod(boolean plain, JMethodDef methodDef)
@link
to a method.plain
- true
to render in plain font, false
to render in monospace
fontmethodDef
- the method to link toCopyright © 2019 JBoss by Red Hat. All rights reserved.