Interface JDocCommentable

All Superinterfaces:

JCommentable

All Known Subinterfaces:

JAnonymousClassDef, JClassDef, JEnumConstant, JMethodDef, JPackageInfoFile, JVarDeclaration

All Known Implementing Classes:

AbstractJClassDef, AbstractJDocCommentable, AbstractJGeneric, AbstractJMethodDef, AnnotationJClassDef, AnnotationJMethodDef, AnonymousJClassDef, BasicJAnnotatable, ConstructorJMethodDef, EnumConstantJClassDef, EnumJClassDef, FirstJVarDeclaration, ImplJAnonymousClassDef, ImplJEnumConstant, ImplJParamDeclaration, InnerJAnonymousClassDef, InterfaceJClassDef, MethodJMethodDef, PlainJClassDef, SuccessorJVarDeclaration, TryJVarDeclaration

public interface JDocCommentable
extends JCommentable

A program element which can have a documentation tag associated with it.

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.

Methods inherited from interface JCommentable

blockComment, lineComment

Method Details

docComment

JDocComment docComment()

Get or create the doc comment for this element.

Returns:

the doc comment body

deprecated

JComment deprecated()

Mark this program element as deprecated.

Returns:

the deprecation tag body