emul/mini/src/main/java/java/lang/annotation/Documented.java
branchemul
changeset 554 05224402145d
parent 66 8a74b5d8d1d4
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/emul/mini/src/main/java/java/lang/annotation/Documented.java	Wed Jan 23 20:39:23 2013 +0100
     1.3 @@ -0,0 +1,43 @@
     1.4 +/*
     1.5 + * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package java.lang.annotation;
    1.30 +
    1.31 +/**
    1.32 + * Indicates that annotations with a type are to be documented by javadoc
    1.33 + * and similar tools by default.  This type should be used to annotate the
    1.34 + * declarations of types whose annotations affect the use of annotated
    1.35 + * elements by their clients.  If a type declaration is annotated with
    1.36 + * Documented, its annotations become part of the public API
    1.37 + * of the annotated elements.
    1.38 + *
    1.39 + * @author  Joshua Bloch
    1.40 + * @since 1.5
    1.41 + */
    1.42 +@Documented
    1.43 +@Retention(RetentionPolicy.RUNTIME)
    1.44 +@Target(ElementType.ANNOTATION_TYPE)
    1.45 +public @interface Documented {
    1.46 +}