RFR: 8329745: Update the documentation of ServerSocket and Socket to refer to StandardSocketOptions instead of legacy SocketOptions [v2]
Alan Bateman
alanb at openjdk.org
Fri Apr 5 12:22:02 UTC 2024
On Fri, 5 Apr 2024 12:06:21 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:
>> Can I please get a review of this doc-only changes to java.net.ServerSocket and java.net.Socket classes?
>>
>> As noted in https://bugs.openjdk.org/browse/JDK-8329745, these classes currently refer to the legacy `java.net.SocketOptions` interface and instead should be refering to the newer `java.net.StandardSocketOptions` class. The commit in this PR updates such references. This change intentionally doesn't do any code changes to use the `StandardSocketOptions` class - that can be done separately if desired at a later point (after testing for any compatibility issues). Finally, there are a few places in ServerSocket and Socket documentation which will continue to refer to java.net.SocketOptions legacy interface because few of the options aren't available in StandardSocketOptions class (for example, `SO_TIMEOUT`).
>>
>> I ran `make docs-image` locally with this change and the generated doc looks OK to me.
>
> Jaikiran Pai has updated the pull request incrementally with one additional commit since the last revision:
>
> remove repeated usages of {@link}
src/java.base/share/classes/java/net/ServerSocket.java line 264:
> 262: * 0 and 65535, inclusive.
> 263: *
> 264: * @see StandardSocketOptions
What would you think about dropping this link, and the link to SocketImpl from all the constructors, they aren't relevant for anyone reading this part of the docs.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/18646#discussion_r1553527158
More information about the net-dev
mailing list