@Documented@Retention(RUNTIME)@Target(ANNOTATION_TYPE)public @interfaceDocumented
If the annotation@Documented is present on the declaration of an annotation typeA, then any@A annotation on an element is considered part of the element's public contract. In more detail, when an annotation typeA is annotated withDocumented, the presence and value of annotations of typeA are a part of the public contract of the elementsA annotates. Conversely, if an annotation typeB isnot annotated withDocumented, the presence and value ofB annotations arenot part of the public contract of the elementsB annotates. Concretely, if an annotation type is annotated with Documented, by default a tool like javadoc will display annotations of that type in its output while annotations of annotation types withoutDocumented will not be displayed.
- Since:
- 1.5