RFR: 8339852: Fix typos in java.compiler documentation

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


On Tue, 10 Sep 2024 16:42:05 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 192:
> 
>> 190: 
>> 191:     /**
>> 192:      * Returns annotations of the specified type that are <em>associated</em>
> 
> Suggestion:
> 
>      * Returns annotations of the specified interface that are <em>associated</em>

Please see the entire javadoc, not just the parts ended up in this diff. There's one more method that uses this term. In general, "type" should not always be changed to "interface" in the context of annotations.

> src/java.compiler/share/classes/javax/lang/model/AnnotatedConstruct.java line 195:
> 
>> 193:      * with this construct.
>> 194:      *
>> 195:      * If there are no annotations of the specified type associated with this
> 
> Suggestion:
> 
>      * If there is no annotation of the specified interface associated with this

See the above comment on "type".

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

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


More information about the compiler-dev mailing list