emul/mini/src/main/java/java/lang/annotation/Documented.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Wed, 23 Jan 2013 20:39:23 +0100
branchemul
changeset 554 05224402145d
parent 66 emul/src/main/java/java/lang/annotation/Documented.java@8a74b5d8d1d4
permissions -rw-r--r--
First attempt to separate 'mini' profile from the rest of JDK APIs
     1 /*
     2  * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    25 
    26 package java.lang.annotation;
    27 
    28 /**
    29  * Indicates that annotations with a type are to be documented by javadoc
    30  * and similar tools by default.  This type should be used to annotate the
    31  * declarations of types whose annotations affect the use of annotated
    32  * elements by their clients.  If a type declaration is annotated with
    33  * Documented, its annotations become part of the public API
    34  * of the annotated elements.
    35  *
    36  * @author  Joshua Bloch
    37  * @since 1.5
    38  */
    39 @Documented
    40 @Retention(RetentionPolicy.RUNTIME)
    41 @Target(ElementType.ANNOTATION_TYPE)
    42 public @interface Documented {
    43 }