Package org.jboss.jdeparser
Interface JComment
- All Known Subinterfaces:
JDocComment
,JHtmlComment
,JHtmlTag
- All Known Implementing Classes:
AbstractJComment
,AbstractJDocComment
,AbstractJHtmlComment
,BlockJComment
,DocTagJHtmlComment
,ImplJDocComment
,ImplJHtmlTag
,InlineDocTagCommentContent
,LineJComment
,NestedCommentContent
,NestedDocCommentContent
,NestedHtmlCommentContent
public interface JComment
A source comment or tag body.
-
Method Summary
Modifier and TypeMethodDescriptionblock()
Add a comment sub-block at this location.code()
Add an inline code tag.docRoot()
Add the{@docRoot}
tag at this position.inlineDocTag
(String tag) Add an inline doc tag.inlineDocTag
(String tag, String body) Add an inline doc tag with simple content.linkConstructor
(boolean plain, JType targetType, JType... targetConstructorArgumentTypes) Add an inline@link
to a constructor.Add an inline@link
to a field of a type.linkMethod
(boolean plain, JMethodDef methodDef) Add an inline@link
to a method.linkMethod
(boolean plain, JType targetType, String targetMethod, JType... targetMethodArgumentTypes) Add an inline@link
to a method.Add an inline@link
to a type.nl()
Add a newline.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.
-
Method Details
-
text
Add some text to the end of this comment. No formatting or line breaks are inserted.- Parameters:
text
- the text to add- Returns:
- this comment
-
sp
JComment sp()Add a non-trailing space. If no content follows, the space will be omitted.- Returns:
- this comment
-
nl
JComment nl()Add a newline.- Returns:
- this comment
-
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.- Parameters:
type
- the type name to add- Returns:
- this comment
-
block
JComment 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.- Returns:
- the comment sub-block
-
inlineDocTag
Add an inline doc tag with simple content.- Parameters:
tag
- the tag name (without the leading@
sign)body
- the complete tag body- Returns:
- this comment
-
inlineDocTag
Add an inline doc tag.- Parameters:
tag
- the tag name (without the leading@
sign)- Returns:
- the body of the doc tag
-
code
JComment code()Add an inline code tag.- Returns:
- the code tag content
-
docRoot
JComment docRoot()Add the{@docRoot}
tag at this position.- Returns:
- this comment
-
linkType
Add an inline@link
to a type.- Parameters:
plain
-true
to render in plain font,false
to render inmonospace
fonttargetType
- the target type to link to- Returns:
- the body of the link tag
-
linkField
Add an inline@link
to a field of a type.- Parameters:
plain
-true
to render in plain font,false
to render inmonospace
fonttargetType
- the target type to link totargetField
- the target field to link to- Returns:
- the body of the link tag
-
linkConstructor
Add an inline@link
to a constructor.- Parameters:
plain
-true
to render in plain font,false
to render inmonospace
fonttargetType
- the target type to link totargetConstructorArgumentTypes
- the argument types of the constructor to link to- Returns:
- the body of the link tag
-
linkMethod
JComment linkMethod(boolean plain, JType targetType, String targetMethod, JType... targetMethodArgumentTypes) Add an inline@link
to a method.- Parameters:
plain
-true
to render in plain font,false
to render inmonospace
fonttargetType
- the target type to link totargetMethod
- the name of the method to link totargetMethodArgumentTypes
- the argument types of the method to link to- Returns:
- the body of the link tag
-
linkMethod
Add an inline@link
to a method.- Parameters:
plain
-true
to render in plain font,false
to render inmonospace
fontmethodDef
- the method to link to- Returns:
- the body of the link tag
-