Modifier and Type | Interface and Description |
---|---|
interface |
JDocComment
A JavaDoc comment.
|
interface |
JHtmlTag |
Modifier and Type | Class and Description |
---|---|
(package private) class |
AbstractJDocComment |
(package private) class |
AbstractJHtmlComment |
(package private) class |
DocTagJHtmlComment |
(package private) class |
ImplJDocComment |
(package private) class |
ImplJHtmlTag |
(package private) class |
NestedDocCommentContent |
(package private) class |
NestedHtmlCommentContent |
Modifier and Type | Method and Description |
---|---|
JHtmlComment |
AbstractJDocComment._return() |
JHtmlComment |
JDocComment._return()
Add a
@return tag. |
JHtmlComment |
AbstractJDocComment._throws(JType exceptionType) |
JHtmlComment |
JDocComment._throws(JType exceptionType)
Add a
@throws tag. |
JHtmlComment |
AbstractJHtmlComment.block() |
JHtmlComment |
JHtmlComment.block()
Add a comment sub-block at this location.
|
JHtmlComment |
AbstractJHtmlComment.br() |
JHtmlComment |
JHtmlComment.br()
Add a line separator.
|
JHtmlComment |
AbstractJHtmlComment.docRoot() |
JHtmlComment |
JHtmlComment.docRoot()
Add the
{@docRoot} tag at this position. |
JHtmlComment |
AbstractJDocComment.docTag(java.lang.String tag) |
JHtmlComment |
JDocComment.docTag(java.lang.String tag)
Add a block tag.
|
JHtmlComment |
AbstractJDocComment.docTag(java.lang.String tag,
java.lang.String firstWord) |
JHtmlComment |
JDocComment.docTag(java.lang.String tag,
java.lang.String firstWord)
Add a block tag.
|
JHtmlComment |
AbstractJHtmlComment.inlineDocTag(java.lang.String tag,
java.lang.String body) |
JHtmlComment |
JHtmlComment.inlineDocTag(java.lang.String tag,
java.lang.String body)
Add an inline doc tag with simple content.
|
JHtmlComment |
AbstractJHtmlComment.nl() |
JHtmlComment |
JHtmlComment.nl()
Add a newline.
|
JHtmlComment |
AbstractJHtmlComment.p() |
JHtmlComment |
JHtmlComment.p()
Add a paragraph separator.
|
JHtmlComment |
AbstractJDocComment.param(java.lang.String name) |
JHtmlComment |
JDocComment.param(java.lang.String name)
Add a
@param tag. |
JHtmlComment |
AbstractJHtmlComment.sp() |
JHtmlComment |
JHtmlComment.sp()
Add a non-trailing space.
|
JHtmlComment |
AbstractJHtmlComment.text(java.lang.String text) |
JHtmlComment |
JHtmlComment.text(java.lang.String text)
Add some text to the end of this comment.
|
JHtmlComment |
AbstractJHtmlComment.typeName(JType type) |
JHtmlComment |
JHtmlComment.typeName(JType type)
Add a type name to the end of this comment.
|
JHtmlComment |
AbstractJHtmlComment.value(JType type,
java.lang.String fieldName) |
JHtmlComment |
JHtmlComment.value(JType type,
java.lang.String fieldName)
Add a
@value inline tag. |