RFR: 8265226: Follow on comments from 8262883: doccheck: Broken links in java.base

[Alan Bateman]

On Wed, 14 Apr 2021 16:49:56 GMT, Michael McMahon <michaelm at openjdk.org> wrote:

> Hi,
> 
> Could I get the following change reviewed please (which may need a CSR)?
> 
> It should have been considered as part of (8262883) which was integrated earlier today.
> Any other comments on that change can be considered here too.
> 
> This is the change:
> 
> 
> diff a/src/java.base/share/classes/java/nio/channels/DatagramChannel.java b/src/java.base/share/classes/java/nio/channels/DatagramChannel.java
> --- a/src/java.base/share/classes/java/nio/channels/DatagramChannel.java
> +++ b/src/java.base/share/classes/java/nio/channels/DatagramChannel.java
> @@ -170,12 +170,11 @@
>       * java.nio.channels.spi.SelectorProvider#openDatagramChannel(ProtocolFamily)
>       * openDatagramChannel} method of the system-wide default {@link
>       * java.nio.channels.spi.SelectorProvider} object.  The channel will not be
>       * connected.
>       *
> -     * @apiNote {@linkplain java.net.UnixDomainSocketAddress Unix domain} sockets
> -     * are not supported by DatagramChannel.
> +     * @apiNote {@link java.net.StandardProtocolFamily#UNIX} is not supported.
>       *
>       * @param   family
>       *          The protocol family
>       *
>       * @return  A new datagram channel
> 
> 
> Thanks,
> 
> Michael.

src/java.base/share/classes/java/nio/channels/DatagramChannel.java line 175:

> 173:      * connected.
> 174:      *
> 175:      * @apiNote {@link java.net.StandardProtocolFamily#UNIX} is not supported.

It might be clearer to restore the original text ("Unix domain sockets are not support by DatagramChannel") and add something like "; invoking this method with the UNIX protocol family throws UnsupportedOperationException". 

(btw: I had changed the description of the JBS issue to reflect what this issue about, hopefully the commit can use the same description).

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

PR: https://git.openjdk.java.net/jdk/pull/3494