Integrated: JDK-8310453: Update javadoc of java.lang.Object

Joe Darcy darcy at openjdk.org
Thu Jun 22 16:41:10 UTC 2023


On Tue, 20 Jun 2023 17:13:26 GMT, Joe Darcy <darcy at openjdk.org> 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.

This pull request has now been integrated.

Changeset: 0e4fde3d
Author:    Joe Darcy <darcy at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/0e4fde3d300b91e6f93fe4d602f99251c75aa847
Stats:     25 lines in 1 file changed: 11 ins; 1 del; 13 mod

8310453: Update javadoc of java.lang.Object

Reviewed-by: rriggs, alanb

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

PR: https://git.openjdk.org/jdk/pull/14567


More information about the core-libs-dev mailing list