Stay organized with collections
Save and categorize content based on your preferences.
Documented
@Target([AnnotationTarget.ANNOTATION_CLASS]) class 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.
Summary
| Public constructors |
|
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.
|
Public constructors
Documented
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# Documented\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nDocumented\n==========\n\n```\n@Target([AnnotationTarget.ANNOTATION_CLASS]) class Documented\n```\n\n|--------------------------------------|\n| [java.lang.annotation.Documented](#) |\n\nIf 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.\n\nSummary\n-------\n\n| Public constructors ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [Documented](#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. |\n\nPublic constructors\n-------------------\n\n### Documented\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nDocumented()\n```\n\nIf 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."]]
