RFR: 8283779: Clarify API documentation of NetworkInterface with respect to configuration changes [v9]

Alan Bateman alanb at openjdk.org
Thu Sep 5 18:46:52 UTC 2024


On Tue, 3 Sep 2024 18:04:34 GMT, Daniel Fuchs <dfuchs at openjdk.org> wrote:

>> Please find here a change that adds a few `@apiNote` and `@implNote` to `NetworkInterface` to clarify user expectation and implementation.
>
> Daniel Fuchs has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Review feedback

src/java.base/share/classes/java/net/NetworkInterface.java line 54:

> 52:  * typically, the set of IP addresses assigned to a network
> 53:  * interface can be transient and dynamically allocated, and may
> 54:  * change at any time.

The new class description is quite good.  After "The network configuration may change during the lifetime of the JVM" you currently have "typically". I think it would be a clearer to say "For example, " instead.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20822#discussion_r1746004767


More information about the net-dev mailing list