RFR: 8329733: Update the documentation in java.net.SocketOptions to direct to java.net.StandardSocketOptions
Jaikiran Pai
jpai at openjdk.org
Fri Apr 5 07:01:20 UTC 2024
Can I please get a review of this doc-only change which proposes to clean up the documentation of `java.net.SocketOptions` interface?
As noted in https://bugs.openjdk.org/browse/JDK-8329733, the existing documentation in this legacy interface isn't accurate. The commit in this PR, updates the documentation on several of the fields to point to the newer java.net.StandardSocketOptions class. While at it, I also did a general update of this documentation to use snippets and also reword some of it to be a bit more clear.
I have run `make docs-image` on this change and the updated doc looks fine to me.
-------------
Commit messages:
- 8329733: Update the documentation in java.net.SocketOptions to direct to java.net.StandardSocketOptions
Changes: https://git.openjdk.org/jdk/pull/18645/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=18645&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8329733
Stats: 170 lines in 1 file changed: 4 ins; 92 del; 74 mod
Patch: https://git.openjdk.org/jdk/pull/18645.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/18645/head:pull/18645
PR: https://git.openjdk.org/jdk/pull/18645
More information about the net-dev
mailing list