public interface JHtmlComment extends JComment
Modifier and Type | Method and Description |
---|---|
JHtmlComment |
block()
Add a comment sub-block at this location.
|
JHtmlComment |
br()
Add a line separator.
|
JHtmlComment |
docRoot()
Add the
{@docRoot} tag at this position. |
JHtmlTag |
htmlLink(String url)
Add an HTML link (
<a> tag). |
JHtmlTag |
htmlTag(String tag,
boolean newLine)
Add an HTML tag.
|
JHtmlComment |
inlineDocTag(String tag,
String body)
Add an inline doc tag with simple content.
|
JHtmlComment |
nl()
Add a newline.
|
JHtmlComment |
p()
Add a paragraph separator.
|
JComment |
preformattedCode()
Add an inline
@code tag within a {@code |
JHtmlComment |
sp()
Add a non-trailing space.
|
JHtmlComment |
text(String text)
Add some text to the end of this comment.
|
JHtmlComment |
typeName(JType type)
Add a type name to the end of this comment.
|
JHtmlComment |
value(JType type,
String fieldName)
Add a
@value inline tag. |
code, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType
JHtmlComment block()
JHtmlComment text(String text)
JHtmlComment inlineDocTag(String tag, String body)
inlineDocTag
in interface JComment
tag
- the tag name (without the leading @
sign)body
- the complete tag bodyJHtmlComment sp()
JHtmlComment nl()
JHtmlComment typeName(JType type)
JHtmlComment docRoot()
{@docRoot}
tag at this position.JHtmlComment p()
JHtmlComment br()
JHtmlComment value(JType type, String fieldName)
@value
inline tag.type
- the value typefieldName
- the value field nameJHtmlTag htmlLink(String url)
<a>
tag).url
- the URL to link toJHtmlTag htmlTag(String tag, boolean newLine)
tag
- the HTML tagnewLine
- true
to add a newline after the opening tag and before the closing tagJComment preformattedCode()
@code
tag within a <pre></pre>
block.Copyright © 2016. All rights reserved.