public interface JDocComment extends JHtmlComment
Modifier and Type | Method and Description |
---|---|
JHtmlComment |
_return()
Add a
@return tag. |
JHtmlComment |
_throws(JType exceptionType)
Add a
@throws tag. |
JDocComment |
block()
Add a comment sub-block at this location.
|
JDocComment |
br()
Add a line separator.
|
JDocComment |
docRoot()
Add the
{@docRoot} tag at this position. |
JHtmlComment |
docTag(String tag)
Add a block tag.
|
JHtmlComment |
docTag(String tag,
String firstWord)
Add a block tag.
|
JComment |
inlineDocTag(String tag)
Add an inline doc tag.
|
JDocComment |
inlineDocTag(String tag,
String body)
Add an inline doc tag with simple content.
|
JDocComment |
nl()
Add a newline.
|
JDocComment |
p()
Add a paragraph separator.
|
JHtmlComment |
param(String name)
Add a
@param tag. |
JDocComment |
sp()
Add a non-trailing space.
|
JDocComment |
text(String text)
Add some text to the end of this comment.
|
JDocComment |
typeName(JType type)
Add a type name to the end of this comment.
|
JDocComment |
value(JType type,
String fieldName)
Add a
@value inline tag. |
htmlLink, htmlTag, preformattedCode
code, linkConstructor, linkField, linkMethod, linkMethod, linkType
JDocComment text(String text)
text
in interface JComment
text
in interface JHtmlComment
text
- the text to addJDocComment block()
block
in interface JComment
block
in interface JHtmlComment
JDocComment inlineDocTag(String tag, String body)
inlineDocTag
in interface JComment
inlineDocTag
in interface JHtmlComment
tag
- the tag name (without the leading @
sign)body
- the complete tag bodyJComment inlineDocTag(String tag)
inlineDocTag
in interface JComment
tag
- the tag name (without the leading @
sign)JDocComment sp()
sp
in interface JComment
sp
in interface JHtmlComment
JDocComment nl()
nl
in interface JComment
nl
in interface JHtmlComment
JDocComment p()
p
in interface JHtmlComment
JDocComment br()
br
in interface JHtmlComment
JDocComment typeName(JType type)
typeName
in interface JComment
typeName
in interface JHtmlComment
type
- the type name to addJDocComment docRoot()
{@docRoot}
tag at this position.docRoot
in interface JComment
docRoot
in interface JHtmlComment
JDocComment value(JType type, String fieldName)
@value
inline tag.value
in interface JHtmlComment
type
- the value typefieldName
- the value field nameJHtmlComment docTag(String tag)
tag
- the tag nameJHtmlComment docTag(String tag, String firstWord)
tag
- the tag namefirstWord
- the tag body first wordJHtmlComment _return()
@return
tag.JHtmlComment _throws(JType exceptionType)
@throws
tag.exceptionType
- the type of exceptionJHtmlComment param(String name)
@param
tag.name
- the parameter nameCopyright © 2019 JBoss by Red Hat. All rights reserved.