Skip to content

8296546: Add @spec tags to API #11073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

8296546: Add @spec tags to API #11073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30ce235
JDK-8296547: Add @spec tags to API
jonathan-gibbons Nov 9, 2022
c29092d
Prefix RFC titles with `RFC NNNN:`
jonathan-gibbons Nov 22, 2022
3905ac8
Remove updates from unexported files
jonathan-gibbons Nov 23, 2022
edf0f74
Merge remote-tracking branch 'upstream/master' into 8296546.add-spec-…
jonathan-gibbons Dec 1, 2022
07882ff
Change ietf.org URLs to use rfc-editor.org
jonathan-gibbons Dec 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/io/ObjectInputStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@
* <cite>Java Object Serialization Specification,</cite> Section 1.13,
* "Serialization of Records"</a> for additional information.
*
* @spec serialization/index.html Java Object Serialization Specification
* @author Mike Warres
* @author Roger Riggs
* @see java.io.DataInput
Expand Down
2 changes: 2 additions & 0 deletions src/java.base/share/classes/java/io/ObjectOutputStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@
* <p>Records are serialized differently than ordinary serializable or externalizable
* objects, see <a href="ObjectInputStream.html#record-serialization">record serialization</a>.
*
* @spec serialization/index.html Java Object Serialization Specification
* @author Mike Warres
* @author Roger Riggs
* @see java.io.DataOutput
Expand Down Expand Up @@ -671,6 +672,7 @@ protected void writeStreamHeader() throws IOException {
*
* @param desc class descriptor to write to the stream
* @throws IOException If an I/O error has occurred.
* @spec serialization/index.html Java Object Serialization Specification
* @see java.io.ObjectInputStream#readClassDescriptor()
* @see #useProtocolVersion(int)
* @see java.io.ObjectStreamConstants#PROTOCOL_VERSION_1
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/io/ObjectStreamClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
* <a href="{@docRoot}/../specs/serialization/class.html#stream-unique-identifiers">
* <cite>Java Object Serialization Specification,</cite> Section 4.6, "Stream Unique Identifiers"</a>.
*
* @spec serialization/index.html Java Object Serialization Specification
* @author Mike Warres
* @author Roger Riggs
* @see ObjectStreamField
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/io/Serial.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
* and methods reflectively and those fields and methods may appear
* otherwise unused in a {@code Serializable} class.
*
* @spec serialization/index.html Java Object Serialization Specification
* @see Serializable
* @see Externalizable
* @since 14
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/io/Serializable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@
* the default computed value, but the requirement for matching
* serialVersionUID values is waived for array classes.
*
* @spec serialization/index.html Java Object Serialization Specification
* @see java.io.ObjectOutputStream
* @see java.io.ObjectInputStream
* @see java.io.ObjectOutput
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/io/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
* <li>{@extLink serialver_tool_reference The serialver tool}</li>
* </ul>
*
* @spec serialization/index.html Java Object Serialization Specification
* @since 1.0
*/
package java.io;
10 changes: 10 additions & 0 deletions src/java.base/share/classes/java/lang/Character.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@
* use instances for synchronization, or unpredictable behavior may
* occur. For example, in a future release, synchronization may fail.
*
* @spec https://www.unicode.org/reports/tr27 Unicode 3.1.0
Copy link
Member

@naotoj naotoj Nov 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be removed, as the original link (explaining U+n notation) is broken.

Copy link
Contributor Author

@jonathan-gibbons jonathan-gibbons Dec 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@naotoj The edits are driven by a script, using info about existing links in the same doc comment. If you don't think this reference is appropriate, it would be better to either remove the existing link (and I'll regenerate this patch) or else this patch goes through and you fix up both the existing link and the @spec tag afterwards.

Copy link
Member

@naotoj naotoj Dec 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either way is fine with me. I will fix it up if you choose the latter.

* @author Lee Boynton
* @author Guy Steele
* @author Akira Tanaka
Expand Down Expand Up @@ -4490,6 +4491,7 @@ public static final UnicodeBlock forName(String blockName) {
* {@link Character.UnicodeScript#COMMON Common} or
* {@link Character.UnicodeScript#UNKNOWN Unknown}.
*
* @spec https://www.unicode.org/reports/tr24 Unicode Script Property
* @since 1.7
*/
public static enum UnicodeScript {
Expand Down Expand Up @@ -10577,6 +10579,8 @@ public static boolean isJavaIdentifierPart(int codePoint) {
* @param ch the character to be tested.
* @return {@code true} if the character may start a Unicode
* identifier; {@code false} otherwise.
* @spec https://www.unicode.org/reports/tr44 Unicode Character Database
* @spec https://www.unicode.org/reports/tr31 Unicode Identifier and Pattern Syntax
* @see Character#isJavaIdentifierStart(char)
* @see Character#isLetter(char)
* @see Character#isUnicodeIdentifierPart(char)
Expand Down Expand Up @@ -10613,6 +10617,8 @@ public static boolean isUnicodeIdentifierStart(char ch) {
* @param codePoint the character (Unicode code point) to be tested.
* @return {@code true} if the character may start a Unicode
* identifier; {@code false} otherwise.
* @spec https://www.unicode.org/reports/tr44 Unicode Character Database
* @spec https://www.unicode.org/reports/tr31 Unicode Identifier and Pattern Syntax
* @see Character#isJavaIdentifierStart(int)
* @see Character#isLetter(int)
* @see Character#isUnicodeIdentifierPart(int)
Expand Down Expand Up @@ -10662,6 +10668,8 @@ public static boolean isUnicodeIdentifierStart(int codePoint) {
* @param ch the character to be tested.
* @return {@code true} if the character may be part of a
* Unicode identifier; {@code false} otherwise.
* @spec https://www.unicode.org/reports/tr44 Unicode Character Database
* @spec https://www.unicode.org/reports/tr31 Unicode Identifier and Pattern Syntax
* @see Character#isIdentifierIgnorable(char)
* @see Character#isJavaIdentifierPart(char)
* @see Character#isLetterOrDigit(char)
Expand Down Expand Up @@ -10707,6 +10715,8 @@ public static boolean isUnicodeIdentifierPart(char ch) {
* @param codePoint the character (Unicode code point) to be tested.
* @return {@code true} if the character may be part of a
* Unicode identifier; {@code false} otherwise.
* @spec https://www.unicode.org/reports/tr44 Unicode Character Database
* @spec https://www.unicode.org/reports/tr31 Unicode Identifier and Pattern Syntax
* @see Character#isIdentifierIgnorable(int)
* @see Character#isJavaIdentifierPart(int)
* @see Character#isLetterOrDigit(int)
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/lang/Enum.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
* java.util.EnumMap map} implementations are available.
*
* @param <E> The type of the enum subclass
* @spec serialization/index.html Java Object Serialization Specification
* @serial exclude
* @author Josh Bloch
* @author Neal Gafter
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/lang/Record.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
* </pre>
* then it must be the case that {@code r.equals(copy)}.
*
* @spec serialization/index.html Java Object Serialization Specification
* @apiNote
* A record class that {@code implements} {@link java.io.Serializable} is said
* to be a <i>serializable record</i>. Serializable records are serialized and
Expand Down
3 changes: 3 additions & 0 deletions src/java.base/share/classes/java/lang/Runtime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
* of any method is executed, nor is any {@linkplain Thread.UncaughtExceptionHandler
* uncaught exception handler}.
*
* @spec jni/index.html Java Native Interface Specification
* @implNote
* Native code typically uses the
* <a href="{@docRoot}/../specs/jni/invocation.html">JNI Invocation API</a>
Expand Down Expand Up @@ -787,6 +788,7 @@ public void runFinalization() {
* a native library image by the host system.
* @throws NullPointerException if {@code filename} is
* {@code null}
* @spec jni/index.html Java Native Interface Specification
* @see java.lang.Runtime#getRuntime()
* @see java.lang.SecurityException
* @see java.lang.SecurityManager#checkLink(java.lang.String)
Expand Down Expand Up @@ -852,6 +854,7 @@ void load0(Class<?> fromClass, String filename) {
* native library image by the host system.
* @throws NullPointerException if {@code libname} is
* {@code null}
* @spec jni/index.html Java Native Interface Specification
* @see java.lang.SecurityException
* @see java.lang.SecurityManager#checkLink(java.lang.String)
*/
Expand Down
2 changes: 2 additions & 0 deletions src/java.base/share/classes/java/lang/System.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2003,6 +2003,7 @@ public static void runFinalization() {
* linked with the VM, or the library cannot be mapped to
* a native library image by the host system.
* @throws NullPointerException if {@code filename} is {@code null}
* @spec jni/index.html Java Native Interface Specification
* @see java.lang.Runtime#load(java.lang.String)
* @see java.lang.SecurityManager#checkLink(java.lang.String)
*/
Expand Down Expand Up @@ -2039,6 +2040,7 @@ public static void load(String filename) {
* linked with the VM, or the library cannot be mapped to a
* native library image by the host system.
* @throws NullPointerException if {@code libname} is {@code null}
* @spec jni/index.html Java Native Interface Specification
* @see java.lang.Runtime#loadLibrary(java.lang.String)
* @see java.lang.SecurityManager#checkLink(java.lang.String)
*/
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/lang/Thread.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1908,6 +1908,7 @@ public final int getPriority() {
* with no arguments. This may result in throwing a
* {@code SecurityException}.
*
* @spec jni/index.html Java Native Interface Specification
* @implNote In the JDK Reference Implementation, if this thread is the
* current thread, and it's a platform thread that was not attached to the
* VM with the Java Native Interface
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/lang/foreign/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,5 +234,6 @@
* For every class in this package, unless specified otherwise, any method arguments of reference
* type must not be null, and any null argument will elicit a {@code NullPointerException}. This fact is not individually
* documented for methods of this API.
* @spec jni/index.html Java Native Interface Specification
*/
package java.lang.foreign;
4 changes: 4 additions & 0 deletions src/java.base/share/classes/java/lang/reflect/AccessibleObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
* object corresponds to a member in an exported or open package
* (see {@link #setAccessible(boolean)}). </p>
*
* @spec jni/index.html Java Native Interface Specification
* @jls 6.6 Access Control
* @since 1.2
* @revised 9
Expand Down Expand Up @@ -202,6 +203,7 @@ public static void setAccessible(AccessibleObject[] array, boolean flag) {
* @param flag the new value for the {@code accessible} flag
* @throws InaccessibleObjectException if access cannot be enabled
* @throws SecurityException if the request is denied by the security manager
* @spec jni/index.html Java Native Interface Specification
* @see #trySetAccessible
* @see java.lang.invoke.MethodHandles#privateLookupIn
* @revised 9
Expand Down Expand Up @@ -268,6 +270,7 @@ boolean setAccessible0(boolean flag) {
* {@code false} if access cannot be enabled.
* @throws SecurityException if the request is denied by the security manager
*
* @spec jni/index.html Java Native Interface Specification
* @since 9
* @see java.lang.invoke.MethodHandles#privateLookupIn
*/
Expand Down Expand Up @@ -461,6 +464,7 @@ public boolean isAccessible() {
* declaring class} of the member.</li>
* </ul>
*
* @spec jni/index.html Java Native Interface Specification
* @since 9
* @jls 6.6 Access Control
* @see #trySetAccessible
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/net/CookieHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
* href="http://www.ietf.org/rfc/rfc2965.txt"><i>RFC&nbsp;2965: HTTP
* State Management Mechanism</i></a>
*
* @spec https://www.rfc-editor.org/info/rfc2965 RFC 2965: HTTP State Management Mechanism
* @author Yingxian Wang
* @since 1.5
*/
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/net/CookieManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
*
* <p>The implementation conforms to <a href="http://www.ietf.org/rfc/rfc2965.txt">RFC 2965</a>, section 3.3.
*
* @spec https://www.rfc-editor.org/info/rfc2965 RFC 2965: HTTP State Management Mechanism
* @see CookiePolicy
* @author Edward Wang
* @since 1.6
Expand Down
2 changes: 2 additions & 0 deletions src/java.base/share/classes/java/net/HttpCookie.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@
*
* <p> HttpCookie class can accept all these 3 forms of syntax.
*
* @spec https://www.rfc-editor.org/info/rfc2109 RFC 2109: HTTP State Management Mechanism
* @spec https://www.rfc-editor.org/info/rfc2965 RFC 2965: HTTP State Management Mechanism
* @author Edward Wang
* @since 1.6
*/
Expand Down
11 changes: 11 additions & 0 deletions src/java.base/share/classes/java/net/IDN.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,13 @@
* Applications are responsible for taking adequate security measures when using
* international domain names.
*
* @spec https://www.rfc-editor.org/info/rfc1122 RFC 1122: Requirements for Internet Hosts - Communication Layers
* @spec https://www.rfc-editor.org/info/rfc1123 RFC 1123: Requirements for Internet Hosts - Application and Support
* @spec https://www.rfc-editor.org/info/rfc3454 RFC 3454: Preparation of Internationalized Strings ("stringprep")
* @spec https://www.rfc-editor.org/info/rfc3490 RFC 3490: Internationalizing Domain Names in Applications (IDNA)
* @spec https://www.rfc-editor.org/info/rfc3491 RFC 3491: Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)
* @spec https://www.rfc-editor.org/info/rfc3492 RFC 3492: Punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in Applications (IDNA)
* @spec https://www.unicode.org/reports/tr36 Unicode Security Considerations
* @author Edward Wang
* @since 1.6
*
Expand Down Expand Up @@ -107,6 +114,7 @@ public final class IDN {
* @return the translated {@code String}
*
* @throws IllegalArgumentException if the input string doesn't conform to RFC 3490 specification
* @spec https://www.rfc-editor.org/info/rfc3490 RFC 3490: Internationalizing Domain Names in Applications (IDNA)
*/
public static String toASCII(String input, int flag)
{
Expand Down Expand Up @@ -146,6 +154,7 @@ public static String toASCII(String input, int flag)
* @return the translated {@code String}
*
* @throws IllegalArgumentException if the input string doesn't conform to RFC 3490 specification
* @spec https://www.rfc-editor.org/info/rfc3490 RFC 3490: Internationalizing Domain Names in Applications (IDNA)
*/
public static String toASCII(String input) {
return toASCII(input, 0);
Expand All @@ -169,6 +178,7 @@ public static String toASCII(String input) {
* @param flag process flag; can be 0 or any logical OR of possible flags
*
* @return the translated {@code String}
* @spec https://www.rfc-editor.org/info/rfc3490 RFC 3490: Internationalizing Domain Names in Applications (IDNA)
*/
public static String toUnicode(String input, int flag) {
int p = 0, q = 0;
Expand Down Expand Up @@ -205,6 +215,7 @@ public static String toUnicode(String input, int flag) {
* @param input the string to be processed
*
* @return the translated {@code String}
* @spec https://www.rfc-editor.org/info/rfc3490 RFC 3490: Internationalizing Domain Names in Applications (IDNA)
*/
public static String toUnicode(String input) {
return toUnicode(input, 0);
Expand Down
3 changes: 3 additions & 0 deletions src/java.base/share/classes/java/net/Inet4Address.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@
* 255 are global. However, the administrative scoping is preferred.
* Please refer to <a href="http://www.ietf.org/rfc/rfc2365.txt">
* <i>RFC&nbsp;2365: Administratively Scoped IP Multicast</i></a>
* @spec https://www.rfc-editor.org/info/rfc1918 RFC 1918: Address Allocation for Private Internets
* @spec https://www.rfc-editor.org/info/rfc2365 RFC 2365: Administratively Scoped IP Multicast
* @spec https://www.rfc-editor.org/info/rfc790 RFC 790: Assigned numbers
* @since 1.4
*/

Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/net/Inet6Address.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@
* <p> Note also, that the numeric <i>scope_id</i> can be retrieved from
* Inet6Address instances returned from the NetworkInterface class. This can be
* used to find out the current scope ids configured on the system.
* @spec https://www.rfc-editor.org/info/rfc2373 RFC 2373: IP Version 6 Addressing Architecture
* @since 1.4
*/

Expand Down
8 changes: 8 additions & 0 deletions src/java.base/share/classes/java/net/InetAddress.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,10 @@
* </dd>
* </dl>
*
* @spec https://www.rfc-editor.org/info/rfc1918 RFC 1918: Address Allocation for Private Internets
* @spec https://www.rfc-editor.org/info/rfc2365 RFC 2365: Administratively Scoped IP Multicast
* @spec https://www.rfc-editor.org/info/rfc2373 RFC 2373: IP Version 6 Addressing Architecture
* @spec https://www.rfc-editor.org/info/rfc790 RFC 790: Assigned numbers
* @author Chris Warth
* @see java.net.InetAddress#getByAddress(byte[])
* @see java.net.InetAddress#getByAddress(java.lang.String, byte[])
Expand Down Expand Up @@ -1408,6 +1412,8 @@ public static InetAddress getByAddress(String host, byte[] addr)
* for a global IPv6 address.
* @throws SecurityException if a security manager exists
* and its checkConnect method doesn't allow the operation
* @spec https://www.rfc-editor.org/info/rfc2373 RFC 2373: IP Version 6 Addressing Architecture
* @spec https://www.rfc-editor.org/info/rfc3330 RFC 3330: Special-Use IPv4 Addresses
*/
public static InetAddress getByName(String host)
throws UnknownHostException {
Expand Down Expand Up @@ -1451,6 +1457,8 @@ public static InetAddress getByName(String host)
* @throws SecurityException if a security manager exists and its
* {@code checkConnect} method doesn't allow the operation.
*
* @spec https://www.rfc-editor.org/info/rfc2373 RFC 2373: IP Version 6 Addressing Architecture
* @spec https://www.rfc-editor.org/info/rfc3330 RFC 3330: Special-Use IPv4 Addresses
* @see SecurityManager#checkConnect
*/
public static InetAddress[] getAllByName(String host)
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/net/ResponseCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
* href="http://www.ietf.org/rfc/rfc2616.txt"><i>RFC&nbsp;2616: Hypertext
* Transfer Protocol -- HTTP/1.1</i></a>
*
* @spec https://www.rfc-editor.org/info/rfc2616 RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1
* @author Yingxian Wang
* @since 1.5
*/
Expand Down
1 change: 1 addition & 0 deletions src/java.base/share/classes/java/net/SocketPermission.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
* transfer and share confidential data among parties who may not
* otherwise have access to the data.
*
* @spec https://www.rfc-editor.org/info/rfc2732 RFC 2732: Format for Literal IPv6 Addresses in URL's
* @see java.security.Permissions
* @see SocketPermission
*
Expand Down
7 changes: 7 additions & 0 deletions src/java.base/share/classes/java/net/StandardSocketOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ private StandardSocketOptions() { }
* require that the Java virtual machine be started with implementation
* specific privileges to enable this option or send broadcast datagrams.
*
* @spec https://www.rfc-editor.org/info/rfc919 RFC 919: Broadcasting Internet Datagrams
* @see <a href="http://www.ietf.org/rfc/rfc919.txt">RFC&nbsp;929:
* Broadcasting Internet Datagrams</a>
Comment on lines +60 to 62
Copy link
Member

@dfuch dfuch Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This @see line should now be removed since it's referencing the exact same document.

* @see DatagramSocket#setBroadcast
Expand All @@ -77,6 +78,7 @@ private StandardSocketOptions() { }
* <p> The initial value of this socket option is {@code FALSE}. The socket
* option may be enabled or disabled at any time.
*
* @spec https://www.rfc-editor.org/info/rfc1122 RFC 1122: Requirements for Internet Hosts - Communication Layers
* @see <a href="http://www.ietf.org/rfc/rfc1122.txt">RFC&nbsp;1122
* Requirements for Internet Hosts -- Communication Layers</a>
Comment on lines +81 to 83
Copy link
Member

@dfuch dfuch Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same remark here: please remove the @see

* @see Socket#setKeepAlive
Expand Down Expand Up @@ -147,6 +149,7 @@ private StandardSocketOptions() { }
* socket receive buffer to be changed after the socket is bound is system
* dependent.
*
* @spec https://www.rfc-editor.org/info/rfc1323 RFC 1323: TCP Extensions for High Performance
* @see <a href="http://www.ietf.org/rfc/rfc1323.txt">RFC&nbsp;1323: TCP
* Extensions for High Performance</a>
Comment on lines 153 to 154
Copy link
Member

@dfuch dfuch Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the @see

* @see Socket#setReceiveBufferSize
Expand Down Expand Up @@ -179,6 +182,7 @@ private StandardSocketOptions() { }
* after the socket is bound has no effect. The default value of this
* socket option is system dependent.
*
* @spec https://www.rfc-editor.org/info/rfc793 RFC 793: Transmission Control Protocol
* @see <a href="http://www.ietf.org/rfc/rfc793.txt">RFC&nbsp;793: Transmission
Comment on lines +185 to 186
Copy link
Member

@dfuch dfuch Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the @see

* Control Protocol</a>
* @see ServerSocket#setReuseAddress
Expand Down Expand Up @@ -268,6 +272,8 @@ private StandardSocketOptions() { }
* {@link StandardProtocolFamily#INET6 IPv6} socket, is not defined in this
* release.
*
* @spec https://www.rfc-editor.org/info/rfc1349 RFC 1349: Type of Service in the Internet Protocol Suite
* @spec https://www.rfc-editor.org/info/rfc2474 RFC 2474: Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers
* @see DatagramSocket#setTrafficClass
*/
public static final SocketOption<Integer> IP_TOS =
Expand Down Expand Up @@ -366,6 +372,7 @@ private StandardSocketOptions() { }
* disabled. If it cannot, then invoking the {@code setOption} method to
* disable the option has no effect.
*
* @spec https://www.rfc-editor.org/info/rfc1122 RFC 1122: Requirements for Internet Hosts - Communication Layers
* @see <a href="http://www.ietf.org/rfc/rfc1122.txt">RFC&nbsp;1122:
* Requirements for Internet Hosts -- Communication Layers</a>
Comment on lines +375 to 377
Copy link
Member

@dfuch dfuch Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the @see

* @see Socket#setTcpNoDelay
Expand Down
Loading