Package org.jboss.jdeparser
Interface JDocCommentable
-
- All Superinterfaces:
JCommentable
- All Known Subinterfaces:
JAnonymousClassDef
,JClassDef
,JEnumConstant
,JMethodDef
,JPackageInfoFile
,JVarDeclaration
public interface JDocCommentable extends JCommentable
A program element which can have a documentation tag associated with it.- Author:
- David M. Lloyd
-
-
Method Summary
All Methods Instance Methods Abstract 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.-
Methods inherited from interface org.jboss.jdeparser.JCommentable
blockComment, lineComment
-
-
-
-
Method Detail
-
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
-
-