jdk/src/java.base/share/classes/java/lang/annotation/Documented.java
author darcy
Mon, 11 May 2015 17:54:03 -0700
changeset 30440 376bb53438b7
parent 25859 3317bb8137f4
permissions -rw-r--r--
8053918: make the spec for @Documented comprehensible Reviewed-by: jjg, abuckley
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang.annotation;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
30440
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    29
 * If the annotation {@code @Documented} is present on the declaration
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    30
 * of an annotation type <i>A</i>, then any {@code @A} annotation on
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    31
 * an element is considered part of the element's public contract.
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    32
 *
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    33
 * In more detail, when an annotation type <i>A</i> is annotated with
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    34
 * {@code Documented}, the presence and value of annotations of type
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    35
 * <i>A</i> are a part of the public contract of the elements <i>A</i>
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    36
 * annotates.
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    37
 *
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    38
 * Conversely, if an annotation type <i>B</i> is <em>not</em>
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    39
 * annotated with {@code Documented}, the presence and value of
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    40
 * <i>B</i> annotations are <em>not</em> part of the public contract
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    41
 * of the elements <i>B</i> annotates.
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    42
 *
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    43
 * Concretely, if an annotation type is annotated with {@code
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    44
 * Documented}, by default a tool like javadoc will display
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    45
 * annotations of that type in its output while annotations of
376bb53438b7 8053918: make the spec for @Documented comprehensible
darcy
parents: 25859
diff changeset
    46
 * annotation types without {@code Documented} will not be displayed.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @author  Joshua Bloch
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
@Documented
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
@Retention(RetentionPolicy.RUNTIME)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
@Target(ElementType.ANNOTATION_TYPE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
public @interface Documented {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
}