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
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionMark this program element as deprecated.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 Details
-
docComment
-
-
Constructor Details
-
AbstractJDocCommentable
AbstractJDocCommentable()
-
-
Method Details
-
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
Description copied from interface:JDocCommentable
Mark this program element as deprecated.- Specified by:
deprecated
in interfaceJDocCommentable
- Returns:
- the deprecation tag body
-
writeDocComments
- Throws:
IOException
-