Package org.jboss.jdeparser
Interface JDocComment
- All Superinterfaces:
JComment
,JHtmlComment
A JavaDoc comment.
- Author:
- David M. Lloyd
-
Method Summary
Modifier and TypeMethodDescription_return()
Add a@return
tag.Add a@throws
tag.block()
Add a comment sub-block at this location.br()
Add a line separator.docRoot()
Add the{@docRoot}
tag at this position.Add a block tag.Add a block tag.inlineDocTag
(String tag) Add an inline doc tag.inlineDocTag
(String tag, String body) Add an inline doc tag with simple content.nl()
Add a newline.p()
Add a paragraph separator.Add a@param
tag.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, linkConstructor, linkField, linkMethod, linkMethod, linkType
Methods inherited from interface org.jboss.jdeparser.JHtmlComment
htmlLink, htmlTag, preformattedCode
-
Method Details
-
text
Add some text to the end of this comment. No formatting or line breaks are inserted.- Specified by:
text
in interfaceJComment
- Specified by:
text
in interfaceJHtmlComment
- Parameters:
text
- the text to add- Returns:
- this comment
-
block
JDocComment 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.- Specified by:
block
in interfaceJComment
- Specified by:
block
in interfaceJHtmlComment
- Returns:
- the comment sub-block
-
inlineDocTag
Add an inline doc tag with simple content.- Specified by:
inlineDocTag
in interfaceJComment
- Specified by:
inlineDocTag
in interfaceJHtmlComment
- Parameters:
tag
- the tag name (without the leading@
sign)body
- the complete tag body- Returns:
- this comment
-
inlineDocTag
Add an inline doc tag.- Specified by:
inlineDocTag
in interfaceJComment
- Parameters:
tag
- the tag name (without the leading@
sign)- Returns:
- the body of the doc tag
-
sp
JDocComment sp()Add a non-trailing space. If no content follows, the space will be omitted.- Specified by:
sp
in interfaceJComment
- Specified by:
sp
in interfaceJHtmlComment
- Returns:
- this comment
-
nl
JDocComment nl()Add a newline.- Specified by:
nl
in interfaceJComment
- Specified by:
nl
in interfaceJHtmlComment
- Returns:
- this comment
-
p
JDocComment p()Add a paragraph separator.- Specified by:
p
in interfaceJHtmlComment
- Returns:
- this HTML comment
-
br
JDocComment br()Add a line separator.- Specified by:
br
in interfaceJHtmlComment
- Returns:
- this HTML 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.- Specified by:
typeName
in interfaceJComment
- Specified by:
typeName
in interfaceJHtmlComment
- Parameters:
type
- the type name to add- Returns:
- this comment
-
docRoot
JDocComment docRoot()Add the{@docRoot}
tag at this position.- Specified by:
docRoot
in interfaceJComment
- Specified by:
docRoot
in interfaceJHtmlComment
- Returns:
- this comment
-
value
Add a@value
inline tag.- Specified by:
value
in interfaceJHtmlComment
- Parameters:
type
- the value typefieldName
- the value field name- Returns:
- this HTML comment
-
docTag
Add a block tag.- Parameters:
tag
- the tag name- Returns:
- the block tag comment block
-
docTag
Add a block tag.- Parameters:
tag
- the tag namefirstWord
- the tag body first word- Returns:
- the block tag comment block
-
_return
JHtmlComment _return()Add a@return
tag.- Returns:
- the tag body
-
_throws
Add a@throws
tag.- Parameters:
exceptionType
- the type of exception- Returns:
- the tag body
-
param
Add a@param
tag.- Parameters:
name
- the parameter name- Returns:
- the tag body
-