RFR: 8182992 Typo in DatagramPacket constructor API doc

Seán Coffey sean.coffey at oracle.com
Thu Jan 3 17:00:56 UTC 2019


Looks fine to me. We can update the bug summary to make it more general 
to affected classes.

I can help sponsor this change if required.

regards,
Sean.

On 03/01/2019 16:51, Roger Calnan wrote:
> 	I was looking at the fix for:
>
> https://bugs.openjdk.java.net/browse/JDK-8182992 Typo in DatagramPacket constructor API doc
>
> and searched around for other similar issues.  I found:
>
> 4 in networking
> 2 in SQL
> 2 in client libs
>
> all of which are cases of missing spaces.  I will ask for review of the the client ones on the
> client alias but was hoping to review the rest as one, as they are all very similar.  Let me
> know if the reviews should be separated out,
>
> 	Thanks,
>
> 	Roger
>
>
> https://bugs.openjdk.java.net/browse/JDK-8182992 <https://bugs.openjdk.java.net/browse/JDK-8182992> Typo in DatagramPacket constructor API doc
> diff -r 3d0f6ef91216 src/java.base/share/classes/java/net/DatagramPacket.java
> --- a/src/java.base/share/classes/java/net/DatagramPacket.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.base/share/classes/java/net/DatagramPacket.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -102,7 +102,7 @@
>   
>       /**
>        * Constructs a datagram packet for sending packets of length
> -     * {@code length} with offset {@code ioffset}to the
> +     * {@code length} with offset {@code offset} to the
>        * specified port number on the specified host. The
>        * {@code length} argument must be less than or equal to
>        * {@code buf.length}.
> @@ -125,7 +125,7 @@
>   
>       /**
>        * Constructs a datagram packet for sending packets of length
> -     * {@code length} with offset {@code ioffset}to the
> +     * {@code length} with offset {@code offset} to the
>        * specified port number on the specified host. The
>        * {@code length} argument must be less than or equal to
>        * {@code buf.length}.
>
> JDK-8215912 Various Typos in java.net <http://java.net/> Method Documentation
> https://bugs.openjdk.java.net/browse/JDK-8215912 <https://bugs.openjdk.java.net/browse/JDK-8215912>
>
> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html#isReachable(java.net.NetworkInterface,int,int) <https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html#isReachable(java.net.NetworkInterface,int,int)>
> https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/InetAddress.java#l534 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/InetAddress.java#l534>
>
> diff -r 3d0f6ef91216 src/java.base/share/classes/java/net/InetAddress.java
> --- a/src/java.base/share/classes/java/net/InetAddress.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.base/share/classes/java/net/InetAddress.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 1995, 2018, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -531,7 +531,7 @@
>        * @param   timeout the time, in milliseconds, before the call aborts
>        * @throws  IllegalArgumentException if either {@code timeout}
>        *                          or {@code ttl} are negative.
> -     * @return a {@code boolean}indicating if the address is reachable.
> +     * @return a {@code boolean} indicating if the address is reachable.
>        * @throws IOException if a network error occurs
>        * @since 1.5
>        */
>
> https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/Socket.java#l1105 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/Socket.java#l1105>
> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/Socket.html#getOOBInline() <https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/Socket.html#getOOBInline()>
>
> diff -r 3d0f6ef91216 src/java.base/share/classes/java/net/Socket.java
> --- a/src/java.base/share/classes/java/net/Socket.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.base/share/classes/java/net/Socket.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 1995, 2018, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -1102,7 +1102,7 @@
>        * Tests if {@link SocketOptions#SO_OOBINLINE SO_OOBINLINE} is enabled.
>        *
>        * @return a {@code boolean} indicating whether or not
> -     *         {@link SocketOptions#SO_OOBINLINE SO_OOBINLINE}is enabled.
> +     *         {@link SocketOptions#SO_OOBINLINE SO_OOBINLINE} is enabled.
>        *
>        * @exception SocketException if there is an error
>        * in the underlying protocol, such as a TCP error.
>
>
> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URLConnection.html#getHeaderField(int) <https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URLConnection.html#getHeaderField(int)>
> https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/URLConnection.java#l684 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.base/share/classes/java/net/URLConnection.java#l684>
>
> diff -r 3d0f6ef91216 src/java.base/share/classes/java/net/URLConnection.java
> --- a/src/java.base/share/classes/java/net/URLConnection.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.base/share/classes/java/net/URLConnection.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 1995, 2017, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -681,7 +681,7 @@
>       /**
>        * Returns the value for the {@code n}<sup>th</sup> header field.
>        * It returns {@code null} if there are fewer than
> -     * {@code n+1}fields.
> +     * {@code n+1} fields.
>        * <p>
>        * This method can be used in conjunction with the
>        * {@link #getHeaderFieldKey(int) getHeaderFieldKey} method to iterate through all
>
>
>
>
> JDK-8215911 Various Typos in SQL Method Documentation
> https://bugs.openjdk.java.net/browse/JDK-8215911 <https://bugs.openjdk.java.net/browse/JDK-8215911>https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/internal/SyncResolverImpl.java#l1067 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/internal/SyncResolverImpl.java#l1067>
>
> diff -r 3d0f6ef91216 src/java.sql.rowset/share/classes/com/sun/rowset/internal/SyncResolverImpl.java
> --- a/src/java.sql.rowset/share/classes/com/sun/rowset/internal/SyncResolverImpl.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.sql.rowset/share/classes/com/sun/rowset/internal/SyncResolverImpl.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -1064,7 +1064,7 @@
>   
>       /**
>        * Returns the insert row or the current row of this
> -     * {@code CachedRowSetImpl}object.
> +     * {@code CachedRowSetImpl} object.
>        *
>        * @return the {@code Row} object on which this {@code CachedRowSetImpl}
>        * objects's cursor is positioned
> @@ -4326,7 +4326,7 @@
>        *
>        * @param columnName a {@code String} object that must match the
>        *        SQL name of a column in this rowset, ignoring case
> -     * @param c the new column {@code Clob}value
> +     * @param c the new column {@code Clob} value
>        * @throws SQLException if (1) the given column name does not match the
>        *            name of a column in this rowset, (2) the cursor is not on
>        *            one of this rowset's rows or its insert row, or (3) this
>
> https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java#l1136 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java#l1136>
> https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java#l6191 <https://hg.openjdk.java.net/jdk/jdk/file/abe21b82ff7c/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java#l6191>
>
> diff -r abe21b82ff7c src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java
> diff -r 3d0f6ef91216 src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java
> --- a/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java	Wed Jan 02 13:37:55 2019 -0500
> +++ b/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java	Wed Jan 02 13:19:38 2019 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -1133,7 +1133,7 @@
>        * as a stream of Unicode characters.
>        * The value can then be read in chunks from the
>        * stream. This method is particularly
> -     * suitable for retrieving large{@code LONGVARCHAR}values.  The JDBC driver will
> +     * suitable for retrieving large{@code LONGVARCHAR} values.  The JDBC driver will
>        * do any necessary conversion from the database format into Unicode.
>        * The byte format of the Unicode stream must be Java UTF-8,
>        * as specified in the Java virtual machine specification.
> @@ -6188,7 +6188,7 @@
>      * @param parameterIndex index of the first parameter is 1, the second is 2, ...
>      * @param reader An object that contains the data to set the parameter value to.
>      * @throws SQLException if a database access error occurs, this method is called on
> -   *         a closed {@code PreparedStatement}or if parameterIndex does not correspond to a parameter
> +   *         a closed {@code PreparedStatement} or if parameterIndex does not correspond to a parameter
>      *         marker in the SQL statement
>      *
>      * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
>
>


More information about the core-libs-dev mailing list