RFR: 8339852: Fix typos in java.compiler documentation

Pavel Rappo prappo at openjdk.org
Tue Sep 10 18:01:04 UTC 2024


On Tue, 10 Sep 2024 16:41:21 GMT, Chen Liang <liach at openjdk.org> wrote:

>> Please review this PR to fix typos and formatting issues. Some typos are trivial, others relate to domain vocabulary.
>
> src/java.compiler/share/classes/javax/lang/model/AnnotatedConstruct.java line 55:
> 
>> 53:  * <p>In the definitions below, an annotation <i>A</i> has an
>> 54:  * annotation interface <i>AI</i>. If <i>AI</i> is a repeatable annotation
>> 55:  * interface, the type of the container annotation is <i>AIC</i>.
> 
> "the annotation interface of the container annotation is *AIC*"
> or
> "the containing annotation interface is *AIC*"
> 
> To align with the JLS.

"Type" is appropriate here and in some other locations in the `AnnotatedConstruct` javadoc. I paid attention to the difference between "contain-ing annotation interface" and "contain-er annotation".

@dansmithcode, please correct me if I'm wrong.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/20937#discussion_r1752433797


More information about the compiler-dev mailing list