1 /* 2 * @(#)Documented.java 1.5 04/02/03 3 * 4 * Copyright 2004 Sun Microsystems, Inc. All rights reserved. 5 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. 6 */ 7 8 package java.lang.annotation; 9 10 /** 11 * Indicates that annotations with a type are to be documented by javadoc 12 * and similar tools by default. This type should be used to annotate the 13 * declarations of types whose annotations affect the use of annotated 14 * elements by their clients. If a type declaration is annotated with 15 * Documented, its annotations become part of the public API 16 * of the annotated elements. 17 * 18 * @author Joshua Bloch 19 * @version 1.5, 02/03/04 20 * @since 1.5 21 */ 22 @Documented 23 @Retention(RetentionPolicy.RUNTIME) 24 @Target(ElementType.ANNOTATION_TYPE) 25 public @interface Documented { 26 } 27