abstract class AbstractJDocComment extends AbstractJHtmlComment implements JDocComment
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.util.List<DocTagJHtmlComment>> |
docTags |
CLOSE_PAREN_CONTENT, COMMA_CONTENT, DOC_ROOT_CONTENT, HASH_CONTENT, NL_CONTENT, OPEN_PAREN_CONTENT
Constructor and Description |
---|
AbstractJDocComment() |
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(java.lang.String tag)
Add a block tag.
|
JHtmlComment |
docTag(java.lang.String tag,
java.lang.String firstWord)
Add a block tag.
|
(package private) java.util.Map<java.lang.String,java.util.List<DocTagJHtmlComment>> |
getDocTags() |
JDocComment |
inlineDocTag(java.lang.String tag,
java.lang.String body)
Add an inline doc tag with simple content.
|
JDocComment |
nl()
Add a newline.
|
JDocComment |
p()
Add a paragraph separator.
|
JHtmlComment |
param(java.lang.String name)
Add a
@param tag. |
JDocComment |
sp()
Add a non-trailing space.
|
JDocComment |
text(java.lang.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,
java.lang.String fieldName)
Add a
@value inline tag. |
add, htmlLink, htmlTag, preformattedCode
add, addItemDirectly, code, getContent, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType, write
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
inlineDocTag
htmlLink, htmlTag, preformattedCode
code, linkConstructor, linkField, linkMethod, linkMethod, linkType
private java.util.Map<java.lang.String,java.util.List<DocTagJHtmlComment>> docTags
public JDocComment block()
JComment
block
in interface JComment
block
in interface JDocComment
block
in interface JHtmlComment
block
in class AbstractJHtmlComment
public JDocComment sp()
JComment
sp
in interface JComment
sp
in interface JDocComment
sp
in interface JHtmlComment
sp
in class AbstractJHtmlComment
public JDocComment nl()
JComment
nl
in interface JComment
nl
in interface JDocComment
nl
in interface JHtmlComment
nl
in class AbstractJHtmlComment
public JDocComment typeName(JType type)
JComment
typeName
in interface JComment
typeName
in interface JDocComment
typeName
in interface JHtmlComment
typeName
in class AbstractJHtmlComment
type
- the type name to addpublic JDocComment text(java.lang.String text)
JComment
text
in interface JComment
text
in interface JDocComment
text
in interface JHtmlComment
text
in class AbstractJHtmlComment
text
- the text to addpublic JDocComment inlineDocTag(java.lang.String tag, java.lang.String body)
JComment
inlineDocTag
in interface JComment
inlineDocTag
in interface JDocComment
inlineDocTag
in interface JHtmlComment
inlineDocTag
in class AbstractJHtmlComment
tag
- the tag name (without the leading @
sign)body
- the complete tag bodypublic JDocComment docRoot()
JComment
{@docRoot}
tag at this position.docRoot
in interface JComment
docRoot
in interface JDocComment
docRoot
in interface JHtmlComment
docRoot
in class AbstractJHtmlComment
public JDocComment p()
JHtmlComment
p
in interface JDocComment
p
in interface JHtmlComment
p
in class AbstractJHtmlComment
public JDocComment br()
JHtmlComment
br
in interface JDocComment
br
in interface JHtmlComment
br
in class AbstractJHtmlComment
public JDocComment value(JType type, java.lang.String fieldName)
JHtmlComment
@value
inline tag.value
in interface JDocComment
value
in interface JHtmlComment
value
in class AbstractJHtmlComment
type
- the value typefieldName
- the value field namepublic JHtmlComment docTag(java.lang.String tag)
JDocComment
docTag
in interface JDocComment
tag
- the tag namepublic JHtmlComment docTag(java.lang.String tag, java.lang.String firstWord)
JDocComment
docTag
in interface JDocComment
tag
- the tag namefirstWord
- the tag body first wordpublic JHtmlComment _return()
JDocComment
@return
tag._return
in interface JDocComment
public JHtmlComment _throws(JType exceptionType)
JDocComment
@throws
tag._throws
in interface JDocComment
exceptionType
- the type of exceptionpublic JHtmlComment param(java.lang.String name)
JDocComment
@param
tag.param
in interface JDocComment
name
- the parameter namejava.util.Map<java.lang.String,java.util.List<DocTagJHtmlComment>> getDocTags()