RFR: 8329745: Update the documentation of ServerSocket and Socket to refer to StandardSocketOptions instead of legacy SocketOptions [v2]
Jaikiran Pai
jpai at openjdk.org
Fri Apr 5 12:45:09 UTC 2024
On Fri, 5 Apr 2024 12:19:13 GMT, Alan Bateman <alanb at openjdk.org> wrote:
>> 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.
These constructors talk about the `{@code createSocketImpl} method`, so I'm guessing the `@see java.net.SocketImpl` was meant to provide reference to the `SocketImpl`. But I think we should just change the `{@code createSocketImpl} method` to `{@link SocketImplFactory#createSocketImpl()} method` and remove these `@see java.net.SocketImpl`.
I guess we could do the same and remove the `@see java.net.SocketImpl` from the constructors of `java.net.Socket` too?
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/18646#discussion_r1553562060
More information about the net-dev
mailing list