Annotation Interface Documented
If the annotation
@Documented is present on the declarationof an annotation interfaceA, then any@A annotation onan element is considered part of the element's public contract.In more detail, when an annotation interfaceA is annotated withDocumented, the presence and value ofA annotationsare a part of the public contract of the elementsAannotates.Conversely, if an annotation interfaceB isnotannotated withDocumented, the presence and value ofB annotations arenot part of the public contractof the elementsB annotates.Concretely, if an annotation interface is annotated withDocumented,by default a tool like javadoc will display annotations of that interfacein its output while annotations of annotation interfaces withoutDocumented will not be displayed.- Since:
- 1.5