Modifier and Type | Interface and Description |
---|---|
interface |
JDocComment
A JavaDoc comment.
|
interface |
JHtmlComment
A comment that supports HTML content.
|
interface |
JHtmlTag |
Modifier and Type | Class and Description |
---|---|
(package private) class |
AbstractJComment |
(package private) class |
AbstractJDocComment |
(package private) class |
AbstractJHtmlComment |
(package private) class |
BlockJComment |
(package private) class |
DocTagJHtmlComment |
(package private) class |
ImplJDocComment |
(package private) class |
ImplJHtmlTag |
(package private) class |
InlineDocTagCommentContent |
(package private) class |
LineJComment |
(package private) class |
NestedCommentContent |
(package private) class |
NestedDocCommentContent |
(package private) class |
NestedHtmlCommentContent |
Modifier and Type | Method and Description |
---|---|
JComment |
AbstractJMethodDef._throws(java.lang.Class<? extends java.lang.Throwable> type) |
JComment |
JMethodDef._throws(java.lang.Class<? extends java.lang.Throwable> type)
Get a
@throws doc comment block. |
JComment |
AnnotationJMethodDef._throws(JType type) |
JComment |
AbstractJMethodDef._throws(JType type) |
JComment |
JMethodDef._throws(JType type)
Get a
@throws doc comment block. |
JComment |
AbstractJMethodDef._throws(java.lang.String type) |
JComment |
JMethodDef._throws(java.lang.String type)
Get a
@throws doc comment block. |
JComment |
JComment.block()
Add a comment sub-block at this location.
|
JComment |
AbstractJComment.block() |
JComment |
JClassDefSectionImpl.blockComment() |
JComment |
SuccessorJVarDeclaration.blockComment() |
JComment |
BasicJCommentable.blockComment() |
JComment |
ImplJAnonymousClassDef.blockComment() |
JComment |
AbstractJAssignableExpr.blockComment() |
JComment |
AbstractJCall.blockComment() |
JComment |
JCommentable.blockComment()
Add a block comment.
|
JComment |
JComment.code()
Add an inline code tag.
|
JComment |
AbstractJComment.code() |
JComment |
SuccessorJVarDeclaration.deprecated() |
JComment |
ImplJAnonymousClassDef.deprecated() |
JComment |
AbstractJDocCommentable.deprecated() |
JComment |
JDocCommentable.deprecated()
Mark this program element as deprecated.
|
JComment |
JParamDeclaration.doc()
Get the
@param JavaDoc block for this parameter. |
JComment |
ImplJParamDeclaration.doc() |
JComment |
JComment.docRoot()
Add the
{@docRoot} tag at this position. |
JComment |
AbstractJComment.docRoot() |
JComment |
JDocComment.inlineDocTag(java.lang.String tag)
Add an inline doc tag.
|
JComment |
JComment.inlineDocTag(java.lang.String tag)
Add an inline doc tag.
|
JComment |
AbstractJComment.inlineDocTag(java.lang.String tag) |
JComment |
JComment.inlineDocTag(java.lang.String tag,
java.lang.String body)
Add an inline doc tag with simple content.
|
JComment |
AbstractJComment.inlineDocTag(java.lang.String tag,
java.lang.String body) |
JComment |
JClassDefSectionImpl.lineComment() |
JComment |
SuccessorJVarDeclaration.lineComment() |
JComment |
BasicJCommentable.lineComment() |
JComment |
ImplJAnonymousClassDef.lineComment() |
JComment |
AbstractJAssignableExpr.lineComment() |
JComment |
AbstractJCall.lineComment() |
JComment |
JCommentable.lineComment()
Add a line comment.
|
JComment |
JComment.linkConstructor(boolean plain,
JType targetType,
JType... targetConstructorArgumentTypes)
Add an inline
@link to a constructor. |
JComment |
AbstractJComment.linkConstructor(boolean plain,
JType targetType,
JType... params) |
JComment |
JComment.linkField(boolean plain,
JType targetType,
java.lang.String targetField)
Add an inline
@link to a field of a type. |
JComment |
AbstractJComment.linkField(boolean plain,
JType targetType,
java.lang.String targetField) |
JComment |
JComment.linkMethod(boolean plain,
JMethodDef methodDef)
Add an inline
@link to a method. |
JComment |
AbstractJComment.linkMethod(boolean plain,
JMethodDef methodDef) |
JComment |
JComment.linkMethod(boolean plain,
JType targetType,
java.lang.String targetMethod,
JType... targetMethodArgumentTypes)
Add an inline
@link to a method. |
JComment |
AbstractJComment.linkMethod(boolean plain,
JType targetType,
java.lang.String targetMethod,
JType... params) |
JComment |
JComment.linkType(boolean plain,
JType targetType)
Add an inline
@link to a type. |
JComment |
AbstractJComment.linkType(boolean plain,
JType targetType) |
JComment |
JComment.nl()
Add a newline.
|
JComment |
AbstractJComment.nl() |
JComment |
AbstractJHtmlComment.preformattedCode() |
JComment |
JHtmlComment.preformattedCode()
Add an inline
@code tag within a {@code |
JComment |
AbstractJMethodDef.returnsDoc() |
JComment |
JMethodDef.returnsDoc()
Get the
@return doc comment block. |
JComment |
JComment.sp()
Add a non-trailing space.
|
JComment |
AbstractJComment.sp() |
JComment |
JComment.text(java.lang.String text)
Add some text to the end of this comment.
|
JComment |
AbstractJComment.text(java.lang.String text) |
JComment |
JComment.typeName(JType type)
Add a type name to the end of this comment.
|
JComment |
AbstractJComment.typeName(JType type) |