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

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 BasicJCommentable

blockComment, lineComment, writeComments

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface JCommentable

blockComment, lineComment

Field Details

docComment

private ImplJDocComment docComment

Constructor Details

AbstractJDocCommentable

AbstractJDocCommentable()

Method Details

docComment

public JDocComment docComment()

Description copied from interface: JDocCommentable

Get or create the doc comment for this element.

Specified by:

docComment in interface JDocCommentable

Returns:

the doc comment body

deprecated

public JComment deprecated()

Description copied from interface: JDocCommentable

Mark this program element as deprecated.

Specified by:

deprecated in interface JDocCommentable

Returns:

the deprecation tag body

writeDocComments

void writeDocComments(SourceFileWriter writer)
               throws IOException

Throws:

IOException