On Tue, 20 Jun 2023 17:13:26 GMT, Joe Darcy <[email protected]> wrote:
> I had occasion to read over the javadoc sources in java.lang.Object recently
> and noticed a few items that could be updated.
>
> There are some new or expanded API notes referring to methods in
> java.util.Objects. I added these references as apiNote items rather than,
> say, `@see` tags since `@see` tag changes would propagate into classes that
> overrode the methods in questions.
>
> Changing toString to use an inline `@return` tag has the consequence of
> omitting a trailing period, "." in the "Returns" section of its javadoc. This
> also omits a trailing period in subclasses that use the `@return` statement
> of Object.toString in their own toString method. Likewise for hashCode.
src/java.base/share/classes/java/lang/Object.java line 160:
> 158: * general contract for the {@code hashCode} method, which states
> 159: * that equal objects must have equal hash codes.
> 160: * <p>The two-argument {@link java.util.Objects#equals(Object,
I recommend a blank line before to make the paragraph break more obvious.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/14567#discussion_r1237051269
