java.lang.annotation
Annotation Type Documented


@Documented
@Retention(value sample code for java.lang.annotation.Retention.value() definition code for java.lang.annotation.Retention.value() =RUNTIME sample code for java.lang.annotation.RetentionPolicy.RUNTIME definition code for java.lang.annotation.RetentionPolicy.RUNTIME )
@Target(value sample code for java.lang.annotation.Target.value() definition code for java.lang.annotation.Target.value() =ANNOTATION_TYPE sample code for java.lang.annotation.ElementType.ANNOTATION_TYPE definition code for java.lang.annotation.ElementType.ANNOTATION_TYPE )
public @interface Documented

Indicates that annotations with a type are to be documented by javadoc and similar tools by default. This type should be used to annotate the declarations of types whose annotations affect the use of annotated elements by their clients. If a type declaration is annotated with Documented, its annotations become part of the public API of the annotated elements.

Since:
1.5