stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8339781: Better use of Javadoc tags in javax.lang.model

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Joe Darcy 2024-09-20 21:27:22 +00:00
parent 64275e6bbf
commit 08b25611f6
4 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/java.compiler/share/classes/javax/annotation/processing/Processor.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2024, 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
@ -32,14 +32,15 @@ import javax.lang.model.element.*;
import javax.lang.model.SourceVersion;
/**
* The interface for an annotation processor.
* The interface for an <dfn>{@index "annotation processor"}</dfn>.
*
* <p>Annotation processing happens in a sequence of {@linkplain
* javax.annotation.processing.RoundEnvironment rounds}. On each
* round, a processor may be asked to {@linkplain #process process} a
* subset of the annotations found on the source and class files
* produced by a prior round. The inputs to the first round of
* processing are the initial inputs to a run of the tool; these
* <p>Annotation processing happens in a sequence of <dfn>rounds</dfn>.
* On each
* {@linkplain RoundEnvironment round}, a processor may be asked to {@linkplain #process process} a
* subset of the annotations found on the
* {@linkplain RoundEnvironment#getRootElements() source and class files
* produced by a prior round}. The inputs to the first round of
* processing are the <dfn>{@index "initial inputs"}</dfn> to a run of the tool; these
* initial inputs can be regarded as the output of a virtual zeroth
* round of processing. If a processor was asked to process on a
* given round, it will be asked to process on subsequent rounds,
@ -77,7 +78,7 @@ import javax.lang.model.SourceVersion;
* protocol being followed, then the processor's behavior is not
* defined by this interface specification.
*
* <p> The tool uses a <i>discovery process</i> to find annotation
* <p> The tool uses a <dfn>{@index "discovery process"}</dfn> to find annotation
* processors and decide whether or not they should be run. By
* configuring the tool, the set of potential processors can be
* controlled. For example, for a {@link javax.tools.JavaCompiler

14
src/java.compiler/share/classes/javax/lang/model/AnnotatedConstruct.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2024, 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
@ -41,8 +41,8 @@ import javax.lang.model.type.*;
*
* As defined by <cite>The Java Language Specification</cite>
* section {@jls 9.7.4}, an annotation on an element is a
* <em>declaration annotation</em> and an annotation on a type is a
* <em>type annotation</em>.
* <dfn>{@index "declaration annotation"}</dfn> and an annotation on a type is a
* <dfn>{@index "type annotation"}</dfn>.
*
* The terms <em>directly present</em>, <em>present</em>,
* <em>indirectly present</em>, and <em>associated </em> are used
@ -54,7 +54,7 @@ import javax.lang.model.type.*;
* annotation interface <i>AI</i>. If <i>AI</i> is a repeatable annotation
* interface, the type of the containing annotation is <i>AIC</i>.
*
* <p>Annotation <i>A</i> is <em>directly present</em> on a construct
* <p>Annotation <i>A</i> is <dfn>{@index "directly present"}</dfn> on a construct
* <i>C</i> if either:
*
* <ul>
@ -87,7 +87,7 @@ import javax.lang.model.type.*;
*
* </ul>
*
* <p>An annotation <i>A</i> is <em>present</em> on a
* <p>An annotation <i>A</i> is <dfn>{@index "present"}</dfn> on a
* construct <i>C</i> if either:
* <ul>
*
@ -99,7 +99,7 @@ import javax.lang.model.type.*;
*
* </ul>
*
* An annotation <i>A</i> is <em>indirectly present</em> on a construct
* An annotation <i>A</i> is <dfn>{@index "indirectly present"}</dfn> on a construct
* <i>C</i> if both:
*
* <ul>
@ -114,7 +114,7 @@ import javax.lang.model.type.*;
*
* </ul>
*
* An annotation <i>A</i> is <em>associated</em> with a construct
* An annotation <i>A</i> is <dfn>{@index "associated"}</dfn> with a construct
* <i>C</i> if either:
*
* <ul>

4
src/java.compiler/share/classes/javax/lang/model/element/NestingKind.java
View File

@ -26,7 +26,7 @@
package javax.lang.model.element;
/**
* The <i>nesting kind</i> of a type element.
* The <dfn>nesting kind</dfn> of a type element.
* Type elements come in four varieties:
* top-level, member, local, and anonymous.
* <i>Nesting kind</i> is a non-standard term used here to denote this
@ -107,7 +107,7 @@ public enum NestingKind {
/**
* Does this constant correspond to a nested type element?
* A <i>nested</i> type element is any that is not top-level.
* A <dfn>nested</dfn> type element is any that is not top-level.
* More specifically, an <i>inner</i> type element is any nested type element that
* is not {@linkplain Modifier#STATIC static}.
* @return whether or not the constant is nested

2
src/java.compiler/share/classes/javax/lang/model/util/Types.java
View File

@ -185,7 +185,7 @@ public interface Types {
/**
* {@return the class of a boxed value of the primitive type argument}
* That is, <i>boxing conversion</i> is applied.
* That is, <dfn>boxing conversion</dfn> is applied.
*
* @param p the primitive type to be converted
* @jls 5.1.7 Boxing Conversion