archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 07:14:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8257637: Update usage of "type" terminology in java.lang.annotation

Browse source 
Reviewed-by: darcy
This commit is contained in:
Julia Boes 2020-12-16 10:46:39 +00:00
parent b5a3a5b621
commit 72dfba8053
9 changed files with 86 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/java.base/share/classes/java/lang/annotation/Documented.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -27,23 +27,23 @@ package java.lang.annotation;
/**
* If the annotation {@code @Documented} is present on the declaration
* of an annotation type <i>A</i>, then any {@code @A} annotation on
* of an annotation interface <i>A</i>, then any {@code @A} annotation on
* an element is considered part of the element's public contract.
*
* In more detail, when an annotation type <i>A</i> is annotated with
* {@code Documented}, the presence and value of annotations of type
* <i>A</i> are a part of the public contract of the elements <i>A</i>
* In more detail, when an annotation interface <i>A</i> is annotated with
* {@code Documented}, the presence and value of <i>A</i> annotations
* are a part of the public contract of the elements <i>A</i>
* annotates.
*
* Conversely, if an annotation type <i>B</i> is <em>not</em>
* Conversely, if an annotation interface <i>B</i> is <em>not</em>
* annotated with {@code Documented}, the presence and value of
* <i>B</i> annotations are <em>not</em> part of the public contract
* of the elements <i>B</i> annotates.
*
* Concretely, if an annotation type is annotated with {@code
* Documented}, by default a tool like javadoc will display
* annotations of that type in its output while annotations of
* annotation types without {@code Documented} will not be displayed.
* Concretely, if an annotation interface is annotated with {@code Documented},
* by default a tool like javadoc will display annotations of that interface
* in its output while annotations of annotation interfaces without
* {@code Documented} will not be displayed.
*
* @author Joshua Bloch
* @since 1.5