Package org.jboss.jdeparser
Interface JHtmlComment
- All Superinterfaces:
JComment
- All Known Subinterfaces:
JDocComment
,JHtmlTag
A comment that supports HTML content.
- Author:
- David M. Lloyd
-
Method Summary
Modifier and TypeMethodDescriptionblock()
Add a comment sub-block at this location.br()
Add a line separator.docRoot()
Add the{@docRoot}
tag at this position.Add an HTML link (<a>
tag).Add an HTML tag.inlineDocTag
(String tag, String body) Add an inline doc tag with simple content.nl()
Add a newline.p()
Add a paragraph separator.Add an inline@code
tag within a<pre></pre>
block.sp()
Add a non-trailing space.Add some text to the end of this comment.Add a type name to the end of this comment.Add a@value
inline tag.Methods inherited from interface org.jboss.jdeparser.JComment
code, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType
-
Method Details
-
block
JHtmlComment block()Add a comment sub-block at this location. The block has no visual representation but allows text to be inserted at the point of the block even after more content was appended after it. -
text
Add some text to the end of this comment. No formatting or line breaks are inserted. -
inlineDocTag
Add an inline doc tag with simple content.- Specified by:
inlineDocTag
in interfaceJComment
- Parameters:
tag
- the tag name (without the leading@
sign)body
- the complete tag body- Returns:
- this comment
-
sp
JHtmlComment sp()Add a non-trailing space. If no content follows, the space will be omitted. -
nl
JHtmlComment nl()Add a newline. -
typeName
Add a type name to the end of this comment. If the type is imported, it will emit as a simple name, otherwise it will emit as a qualified name. -
docRoot
JHtmlComment docRoot()Add the{@docRoot}
tag at this position. -
p
JHtmlComment p()Add a paragraph separator.- Returns:
- this HTML comment
-
br
JHtmlComment br()Add a line separator.- Returns:
- this HTML comment
-
value
Add a@value
inline tag.- Parameters:
type
- the value typefieldName
- the value field name- Returns:
- this HTML comment
-
htmlLink
Add an HTML link (<a>
tag).- Parameters:
url
- the URL to link to- Returns:
- the link tag body
-
htmlTag
Add an HTML tag. The given tag should be a valid HTML 4 or 5 tag.- Parameters:
tag
- the HTML tagnewLine
-true
to add a newline after the opening tag and before the closing tag- Returns:
- the tag body
-
preformattedCode
JComment preformattedCode()Add an inline@code
tag within a<pre></pre>
block.- Returns:
- the preformatted code block content
-