Contents
Hide sidebar Show sidebar
Annotation Interface Documented
If the annotation @Documented is present on the declaration
of an annotation interface A, then any @A annotation on
an element is considered part of the element's public contract.
In more detail, when an annotation interface A is annotated with
Documented, the presence and value of A annotations
are a part of the public contract of the elements A
annotates.
Conversely, if an annotation interface B is not
annotated with Documented, the presence and value of
B annotations are not part of the public contract
of the elements B annotates.
Concretely, if an annotation interface is annotated with Documented,
by default a tool like javadoc will display annotations of that interface
in its output while annotations of annotation interfaces without
Documented will not be displayed.
Since:
1.5
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.