RFR [15] 8241014: Miscellaneous typos in documentation comments

[Paul Sandoz]

--- a/src/java.base/share/classes/java/lang/invoke/MethodType.java
+++ b/src/java.base/share/classes/java/lang/invoke/MethodType.java
@@ -1379,12 +1379,12 @@
 
             /**
              * This implementation returns {@code true} if {@code obj} is another
-             * {@code WeakEntry} whose referent is equals to this referent, or
-             * if {@code obj} is equals to the referent of this. This allows
+             * {@code WeakEntry} whose referent equals to this referent, or
+             * if {@code obj} equals to the referent of this. This allows
              * lookups to be made without wrapping in a {@code WeakEntry}.
              *
              * @param obj the object to compare
-             * @return true if {@code obj} is equals to this or the referent of this
+             * @return true if {@code obj} equals to this or the referent of this
              * @see MethodType#equals(Object)
              * @see Object#equals(Object)
 
Use either:

  whose referent is equal to this referent,

or 

  whose referent equals this referent,

The former is easier just delete the ’s’.

Other bits look good.

Paul.

> On Mar 13, 2020, at 7:03 PM, Ivan Gerasimov <ivan.gerasimov at oracle.com> wrote:
> 
> Hi Pavel!
> 
> Can this please be combined with my collection of typos?
> 
> http://cr.openjdk.java.net/~igerasim/XXXXXXX-typos/00/webrev/
> 
> Just to save cycles on reviewing :)
> 
> With kind regards,
> 
> Ivan
> 
> 
> On 3/13/20 8:42 AM, Pavel Rappo wrote:
>> Hello,
>> 
>> Please review the change for https://bugs.openjdk.java.net/browse/JDK-8241014:
>> 
>>   http://cr.openjdk.java.net/~prappo/8241014/webrev.00/
>> 
>> This is a documentation cleanup. There are no code changes involved,
>> and the changes in documentation are mostly trivial.
>> 
>> The following packages are affected:
>> 
>>     java.lang,
>>     java.nio.file,
>>     java.nio.file.attribute,
>>     java.security,
>>     java.time.chrono,
>>     java.time.temporal,
>>     java.util,
>>     java.util.regex,
>>     java.util.stream,
>>     javax.crypto,
>>     javax.security.cert,
>>     javax.tools
>> 
>> That said, there are two changes that I'd prefer to be carefully reviewed by
>> the experts in the corresponding areas.
>> 
>> The first one is for a suspected typo in the javax.crypto.CryptoPolicyParser
>> class, "AlgrithomParameterSpec". It is not unheard-of for typos to be kept and
>> supported for the sake of backward compatibility. Sadly, we have a number of
>> those in OpenJDK. Even though I performed reasonable checks, the proposed fix
>> should better be verified by the security folk.
>> 
>> The second one is for the doc comment for the java.util.stream.Stream.collect method.
>> 
>>      @apiNote
>>      The following will accumulate strings into an ArrayList:
>> 
>>          List<String> asList = stringStream.collect(Collectors.toList());
>> 
>> Given that the spec for Collectors.toList() clearly says that
>> 
>>     ...There are no guarantees on the type, mutability, serializability, or
>>     thread-safety of the List returned;...
>> 
>> I'd assume that @apiNote should be fixed as proposed.
>> 
>> -Pavel
>> 
>> P.S. Apologies for spamming multiple mailing lists.
>> 
> -- 
> With kind regards,
> Ivan Gerasimov
>