Documented
Stay organized with collections
Save and categorize content based on your preferences.
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.
Inherited Method Summary
From interface
java.lang.annotation.Annotation
|
abstract
Class<? extends Annotation>
|
|
|
abstract
boolean
|
equals( Object obj)
Returns true if the specified object represents an annotation
that is logically equivalent to this one.
|
|
abstract
int
|
hashCode()
Returns the hash code of this annotation, as defined below:
The hash code of an annotation is the sum of the hash codes
of its members (including those with default values), as defined
below:
The hash code of an annotation member is (127 times the hash code
of the member-name as computed by String.hashCode()) XOR
the hash code of the member-value, as defined below:
The hash code of a member-value depends on its type:
|
|
abstract
String
|
toString()
Returns a string representation of this annotation.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003e@Documented\u003c/code\u003e ensures that annotations of a specific type are included in the documentation generated by tools like javadoc.\u003c/p\u003e\n"],["\u003cp\u003eIt is used to annotate type declarations, making their annotations part of the public API for client usage.\u003c/p\u003e\n"],["\u003cp\u003eBy default, javadoc and similar tools will document annotations marked with \u003ccode\u003e@Documented\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003e@Documented\u003c/code\u003e is an annotation type itself, inheriting methods from the \u003ccode\u003ejava.lang.annotation.Annotation\u003c/code\u003e interface.\u003c/p\u003e\n"],["\u003cp\u003eThe inherited methods include \u003ccode\u003eannotationType()\u003c/code\u003e, \u003ccode\u003eequals()\u003c/code\u003e, \u003ccode\u003ehashCode()\u003c/code\u003e, and \u003ccode\u003etoString()\u003c/code\u003e, providing functionality for reflection and comparison.\u003c/p\u003e\n"]]],[],null,["public abstract @interface **Documented** implements [Annotation](../../../../reference/java/lang/annotation/Annotation.html) \nIndicates that annotations with a type are to be documented by javadoc\nand similar tools by default. This type should be used to annotate the\ndeclarations of types whose annotations affect the use of annotated\nelements by their clients. If a type declaration is annotated with\nDocumented, its annotations become part of the public API\nof the annotated elements. \n\nInherited Method Summary \nFrom interface [java.lang.annotation.Annotation](../../../../reference/java/lang/annotation/Annotation.html) \n\n|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Class](../../../../reference/java/lang/Class.html)\\\u003c? extends [Annotation](../../../../reference/java/lang/annotation/Annotation.html)\\\u003e | [annotationType](../../../../reference/java/lang/annotation/Annotation.html#annotationType())() Returns the annotation type of this annotation. |\n| abstract boolean | [equals](../../../../reference/java/lang/annotation/Annotation.html#equals(java.lang.Object))([Object](../../../../reference/java/lang/Object.html) obj) Returns true if the specified object represents an annotation that is logically equivalent to this one. |\n| abstract int | [hashCode](../../../../reference/java/lang/annotation/Annotation.html#hashCode())() Returns the hash code of this annotation, as defined below: The hash code of an annotation is the sum of the hash codes of its members (including those with default values), as defined below: The hash code of an annotation member is (127 times the hash code of the member-name as computed by [String.hashCode()](../../../../reference/java/lang/String.html#hashCode())) XOR the hash code of the member-value, as defined below: The hash code of a member-value depends on its type: - The hash code of a primitive value *v* is equal to *WrapperType* .valueOf(*v*).hashCode(), where *WrapperType* is the wrapper type corresponding to the primitive type of *v* ([Byte](../../../../reference/java/lang/Byte.html), [Character](../../../../reference/java/lang/Character.html), [Double](../../../../reference/java/lang/Double.html), [Float](../../../../reference/java/lang/Float.html), [Integer](../../../../reference/java/lang/Integer.html), [Long](../../../../reference/java/lang/Long.html), [Short](../../../../reference/java/lang/Short.html), or [Boolean](../../../../reference/java/lang/Boolean.html)). |\n| abstract [String](../../../../reference/java/lang/String.html) | [toString](../../../../reference/java/lang/annotation/Annotation.html#toString())() Returns a string representation of this annotation. |"]]
