Documented

AI-generated Key Takeaways

• @Documented ensures that annotations of a specific type are included in the documentation generated by tools like javadoc.

• It is used to annotate type declarations, making their annotations part of the public API for client usage.

• By default, javadoc and similar tools will document annotations marked with @Documented.

• @Documented is an annotation type itself, inheriting methods from the java.lang.annotation.Annotation interface.

• The inherited methods include annotationType(), equals(), hashCode(), and toString(), providing functionality for reflection and comparison.

public abstract @interface Documented implements Annotation

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>	annotationType() Returns the annotation type of this 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: 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, Character, Double, Float, Integer, Long, Short, or Boolean).
abstract String	toString() Returns a string representation of this annotation.