Package org.jboss.jdeparser
Class AbstractJDocCommentable
- java.lang.Object
-
- org.jboss.jdeparser.BasicJCommentable
-
- org.jboss.jdeparser.AbstractJDocCommentable
-
- All Implemented Interfaces:
JCommentable
,JDocCommentable
- Direct Known Subclasses:
BasicJAnnotatable
abstract class AbstractJDocCommentable extends BasicJCommentable implements JDocCommentable
-
-
Field Summary
Fields Modifier and Type Field Description private ImplJDocComment
docComment
-
Constructor Summary
Constructors Constructor Description AbstractJDocCommentable()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JComment
deprecated()
Mark this program element as deprecated.JDocComment
docComment()
Get or create the doc comment for this element.(package private) void
writeDocComments(SourceFileWriter writer)
-
Methods inherited from class org.jboss.jdeparser.BasicJCommentable
blockComment, lineComment, writeComments
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jboss.jdeparser.JCommentable
blockComment, lineComment
-
-
-
-
Field Detail
-
docComment
private ImplJDocComment docComment
-
-
Method Detail
-
docComment
public JDocComment docComment()
Description copied from interface:JDocCommentable
Get or create the doc comment for this element.- Specified by:
docComment
in interfaceJDocCommentable
- Returns:
- the doc comment body
-
deprecated
public JComment deprecated()
Description copied from interface:JDocCommentable
Mark this program element as deprecated.- Specified by:
deprecated
in interfaceJDocCommentable
- Returns:
- the deprecation tag body
-
writeDocComments
void writeDocComments(SourceFileWriter writer) throws java.io.IOException
- Throws:
java.io.IOException
-
-