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