sample/java.lang.annotation.Documented.txt

   1 *java.lang.annotation.Documented* *Documented* Indicates that annotations with a
   2
   3 public interface interface Documented
   4
   5   implements |java.lang.annotation.Annotation|
   6
   7 |java.lang.annotation.Documented_Description|
   8 |java.lang.annotation.Documented_Fields|
   9 |java.lang.annotation.Documented_Constructors|
  10 |java.lang.annotation.Documented_Methods|
  11
  12 ================================================================================
  13
  14 *java.lang.annotation.Documented_Description*
  15
  16 Indicates that annotations with a type are to be documented by javadoc and
  17 similar tools by default. This type should be used to annotate the declarations
  18 of types whose annotations affect the use of annotated elements by their
  19 clients. If a type declaration is annotated with Documented, its annotations
  20 become part of the public API of the annotated elements.
  21
  22