From 374a088c5254f10286b208fc48e8d57c3077d537 Mon Sep 17 00:00:00 2001 From: Jonathan Gibbons Date: Wed, 5 Apr 2023 10:27:52 -0700 Subject: [PATCH 1/2] JDK-8305593: Add @spec tags in java.desktop --- src/java.desktop/share/classes/java/awt/Desktop.java | 2 ++ src/java.desktop/share/classes/java/awt/package-info.java | 4 ++-- .../javax/imageio/plugins/tiff/BaselineTIFFTagSet.java | 3 ++- .../classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java | 2 ++ src/java.desktop/share/classes/javax/print/DocFlavor.java | 6 ++++++ .../classes/javax/print/attribute/standard/Compression.java | 2 ++ .../classes/javax/print/attribute/standard/Fidelity.java | 3 +++ .../javax/print/attribute/standard/MediaSizeName.java | 3 +++ .../javax/print/attribute/standard/package-info.java | 2 ++ .../share/classes/javax/print/package-info.java | 2 ++ src/java.desktop/share/classes/javax/swing/JEditorPane.java | 2 ++ .../share/classes/javax/swing/text/html/CSS.java | 1 + .../share/classes/javax/swing/text/html/package-info.java | 1 + 13 files changed, 30 insertions(+), 3 deletions(-) diff --git a/src/java.desktop/share/classes/java/awt/Desktop.java b/src/java.desktop/share/classes/java/awt/Desktop.java index e1dbb095ef6cb..c4c2ad134da26 100644 --- a/src/java.desktop/share/classes/java/awt/Desktop.java +++ b/src/java.desktop/share/classes/java/awt/Desktop.java @@ -587,6 +587,8 @@ public void mail() throws IOException { * {@code AWTPermission("showWindowWithoutWarningBanner")} * permission, or the calling thread is not allowed to create a * subprocess + * @spec https://www.rfc-editor.org/info/rfc2368 + * RFC 2368: The mailto URL scheme * @see java.net.URI * @see java.awt.AWTPermission */ diff --git a/src/java.desktop/share/classes/java/awt/package-info.java b/src/java.desktop/share/classes/java/awt/package-info.java index 682a371dd8364..8604fb3d0786a 100644 --- a/src/java.desktop/share/classes/java/awt/package-info.java +++ b/src/java.desktop/share/classes/java/awt/package-info.java @@ -54,10 +54,10 @@ * * + * @spec AWT_Native_Interface.html + * The Java AWT Native Interface Specification and Guide * @since 1.0 */ package java.awt; diff --git a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java index 340fe2aee77f8..be2cbf88c06e2 100644 --- a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java +++ b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java @@ -222,7 +222,8 @@ public final class BaselineTIFFTagSet extends TIFFTagSet { * A value to be used with the "Compression" tag. * * @see #TAG_COMPRESSION - * @see DEFLATE specification + * @spec https://www.rfc-editor.org/info/rfc1951 + * RFC 1951: DEFLATE Compressed Data Format Specification version 1.3 */ public static final int COMPRESSION_DEFLATE = 32946; diff --git a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java index 881df65993f7e..29d2a78907687 100644 --- a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java +++ b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java @@ -31,6 +31,8 @@ * A class representing the extra tags found in a * TIFF-F (RFC 2036) file. * + * @spec https://www.rfc-editor.org/info/rfc2306 + * RFC 2306: Tag Image File Format (TIFF) - F Profile for Facsimile * @since 9 */ public final class FaxTIFFTagSet extends TIFFTagSet { diff --git a/src/java.desktop/share/classes/javax/print/DocFlavor.java b/src/java.desktop/share/classes/javax/print/DocFlavor.java index 0e04dfb471c86..ba6c501178cc4 100644 --- a/src/java.desktop/share/classes/javax/print/DocFlavor.java +++ b/src/java.desktop/share/classes/javax/print/DocFlavor.java @@ -383,6 +383,10 @@ * Print Service instance supports without having to load the representation * classes, which may be problematic for limited-resource clients. * + * @spec https://www.rfc-editor.org/info/rfc2045 + * RFC 2045: Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies + * @spec https://www.rfc-editor.org/info/rfc2046 + * RFC 2046: Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types * @author Alan Kaminsky */ public class DocFlavor implements Serializable, Cloneable { @@ -403,6 +407,8 @@ public class DocFlavor implements Serializable, Cloneable { * valid only for the VM which returns it, for use in a {@code DocFlavor}. * This is the charset for all the "HOST" pre-defined {@code DocFlavors} in * the executing VM. + * @spec https://www.rfc-editor.org/info/rfc2278 + * RFC 2278: IANA Charset Registration Procedures */ @SuppressWarnings("removal") public static final String hostEncoding = diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java b/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java index 16af07a723976..d5b5b8f6b357e 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java @@ -67,6 +67,8 @@ public class Compression extends EnumSyntax implements DocAttribute { /** * GNU zip compression technology described in * RFC 1952. + * @spec https://www.rfc-editor.org/info/rfc1952 + * RFC 1952: GZIP file format specification version 4.3 */ public static final Compression GZIP = new Compression(2); diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java b/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java index 9d54a1794c9d1..35aa3d0daf876 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java @@ -47,6 +47,9 @@ * method returns the IPP string representation of the attribute value. See * RFC 2911 Section 15.1 for a * fuller description of the IPP fidelity attribute. + * + * @spec https://www.rfc-editor.org/info/rfc2911 + * RFC 2911: Internet Printing Protocol/1.1: Model and Semantics */ public final class Fidelity extends EnumSyntax implements PrintJobAttribute, PrintRequestAttribute { diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java b/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java index 63846f4415682..9b2d005b4a7c1 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java @@ -42,6 +42,9 @@ * values of the IPP "media" attribute which names media sizes. The names of the * media sizes correspond to those in the IPP 1.1 RFC * RFC 2911 + * + * @spec https://www.rfc-editor.org/info/rfc2911 + * RFC 2911: Internet Printing Protocol/1.1: Model and Semantics */ public class MediaSizeName extends Media { diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java b/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java index 1cf8a257d1fa4..77bf66afcf89f 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java @@ -590,6 +590,8 @@ * later time. {@code IllegalArgumentException} and {@code NullPointerException} * are examples of typical and acceptable run time exceptions for such cases. * + * @spec https://www.rfc-editor.org/info/rfc2911 + * RFC 2911: Internet Printing Protocol/1.1: Model and Semantics * @since 1.4 */ package javax.print.attribute.standard; diff --git a/src/java.desktop/share/classes/javax/print/package-info.java b/src/java.desktop/share/classes/javax/print/package-info.java index 7334ac056558f..aabd1e6958e31 100644 --- a/src/java.desktop/share/classes/javax/print/package-info.java +++ b/src/java.desktop/share/classes/javax/print/package-info.java @@ -127,6 +127,8 @@ * later time. {@code IllegalArgumentException} and {@code NullPointerException} * are examples of typical and acceptable run time exceptions for such cases. * + * @spec https://www.rfc-editor.org/info/rfc2911 + * RFC 2911: Internet Printing Protocol/1.1: Model and Semantics * @since 1.4 */ package javax.print; diff --git a/src/java.desktop/share/classes/javax/swing/JEditorPane.java b/src/java.desktop/share/classes/javax/swing/JEditorPane.java index ee2f174206c0a..00e2db3955664 100644 --- a/src/java.desktop/share/classes/javax/swing/JEditorPane.java +++ b/src/java.desktop/share/classes/javax/swing/JEditorPane.java @@ -1615,6 +1615,8 @@ private void writeObject(ObjectOutputStream s) throws IOException { * it set the client {@link #putClientProperty property} with this name * to Boolean.TRUE. * + * @spec https://www.w3.org/TR/CSS22 + * Cascading Style Sheets Level 2 Revision 2 (CSS 2.2) Specification * @since 1.5 */ public static final String W3C_LENGTH_UNITS = "JEditorPane.w3cLengthUnits"; diff --git a/src/java.desktop/share/classes/javax/swing/text/html/CSS.java b/src/java.desktop/share/classes/javax/swing/text/html/CSS.java index 8a2b94dd9cfe1..59ddf4856b29b 100644 --- a/src/java.desktop/share/classes/javax/swing/text/html/CSS.java +++ b/src/java.desktop/share/classes/javax/swing/text/html/CSS.java @@ -126,6 +126,7 @@ * unless noted, so that * p { margin-top: 10% } will be treated as if no margin-top was specified. * + * @spec https://www.w3.org/TR/REC-CSS1 Cascading Style Sheets, level 1 * @author Timothy Prinzing * @author Scott Violet * @see StyleSheet diff --git a/src/java.desktop/share/classes/javax/swing/text/html/package-info.java b/src/java.desktop/share/classes/javax/swing/text/html/package-info.java index 68f709ff20c32..8f32e2c41cf79 100644 --- a/src/java.desktop/share/classes/javax/swing/text/html/package-info.java +++ b/src/java.desktop/share/classes/javax/swing/text/html/package-info.java @@ -43,6 +43,7 @@ * which HTMLEditorKit is based. * * + * @spec https://www.w3.org/TR/REC-html32.html HTML 3.2 Reference Specification * @since 1.2 * @serial exclude */ From fcccc85fab7af0f9dd5aa25257f1d76639350fad Mon Sep 17 00:00:00 2001 From: Jonathan Gibbons Date: Wed, 31 May 2023 13:25:31 -0700 Subject: [PATCH 2/2] Update narrative references to use `rfc-editor.org` instead of (variants of) `ietf.org` --- src/java.desktop/share/classes/java/awt/Desktop.java | 2 +- .../share/classes/java/awt/peer/DesktopPeer.java | 5 ++++- .../javax/imageio/metadata/doc-files/tiff_metadata.html | 4 ++-- .../classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java | 2 +- src/java.desktop/share/classes/javax/print/DocFlavor.java | 6 +++--- src/java.desktop/share/classes/javax/print/MimeType.java | 8 ++++++-- .../javax/print/attribute/standard/Compression.java | 2 +- .../classes/javax/print/attribute/standard/Fidelity.java | 2 +- .../javax/print/attribute/standard/MediaSizeName.java | 2 +- .../javax/print/attribute/standard/package-info.java | 2 +- .../share/classes/javax/print/package-info.java | 2 +- .../share/classes/sun/awt/image/PNGImageDecoder.java | 2 +- 12 files changed, 23 insertions(+), 16 deletions(-) diff --git a/src/java.desktop/share/classes/java/awt/Desktop.java b/src/java.desktop/share/classes/java/awt/Desktop.java index c4c2ad134da26..1abba965d8be6 100644 --- a/src/java.desktop/share/classes/java/awt/Desktop.java +++ b/src/java.desktop/share/classes/java/awt/Desktop.java @@ -569,7 +569,7 @@ public void mail() throws IOException { *

A {@code mailto:} URI can specify message fields * including "to", "cc", "subject", * "body", etc. See The mailto URL + * href="https://www.rfc-editor.org/info/rfc2368">The mailto URL * scheme (RFC 2368) for the {@code mailto:} URI specification * details. * diff --git a/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java b/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java index 67eda40dd6cf0..c1b13a4e8f3bc 100644 --- a/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java +++ b/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java @@ -99,10 +99,13 @@ public interface DesktopPeer { * * @param mailtoURL represents a mailto URL with specified values of the message. * The syntax of mailto URL is defined by - * RFC2368: The mailto + * RFC2368: The mailto * URL scheme * @throws IOException If the user default mail client is not found, * or it fails to be launched. + * + * @spec https://www.rfc-editor.org/info/rfc2368 + * RFC 2368: The mailto URL scheme */ void mail(URI mailtoURL) throws IOException; diff --git a/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html b/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html index ee6b4a8fe104d..38e23b85086ed 100644 --- a/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html +++ b/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html @@ -565,9 +565,9 @@

Compression

8 Deflate "Zip-in-TIFF" compression (see note following this table) - + ZLIB Compressed Data Format Specification, - + DEFLATE Compressed Data Format Specification diff --git a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java index 29d2a78907687..12d007f694dad 100644 --- a/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java +++ b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java @@ -29,7 +29,7 @@ /** * A class representing the extra tags found in a - * TIFF-F (RFC 2036) file. + * TIFF-F (RFC 2036) file. * * @spec https://www.rfc-editor.org/info/rfc2306 * RFC 2306: Tag Image File Format (TIFF) - F Profile for Facsimile diff --git a/src/java.desktop/share/classes/javax/print/DocFlavor.java b/src/java.desktop/share/classes/javax/print/DocFlavor.java index ba6c501178cc4..448cc78d9e1d9 100644 --- a/src/java.desktop/share/classes/javax/print/DocFlavor.java +++ b/src/java.desktop/share/classes/javax/print/DocFlavor.java @@ -39,8 +39,8 @@ * * * @author Alan Kaminsky + * @spec https://www.rfc-editor.org/info/rfc2045 + * RFC 2045: Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies + * @spec https://www.rfc-editor.org/info/rfc2046 + * RFC 2046: Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types */ class MimeType implements Serializable, Cloneable { diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java b/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java index d5b5b8f6b357e..b1e7f1e89fc38 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java @@ -66,7 +66,7 @@ public class Compression extends EnumSyntax implements DocAttribute { /** * GNU zip compression technology described in - * RFC 1952. + * RFC 1952. * @spec https://www.rfc-editor.org/info/rfc1952 * RFC 1952: GZIP file format specification version 4.3 */ diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java b/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java index 35aa3d0daf876..b0e4b70c87cc5 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java @@ -45,7 +45,7 @@ * name returned by {@code getName()} is the IPP attribute name. The * enumeration's integer value is the IPP enum value. The {@code toString()} * method returns the IPP string representation of the attribute value. See - * RFC 2911 Section 15.1 for a + * RFC 2911 Section 15.1 for a * fuller description of the IPP fidelity attribute. * * @spec https://www.rfc-editor.org/info/rfc2911 diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java b/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java index 9b2d005b4a7c1..f9dde49561052 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java @@ -41,7 +41,7 @@ * IPP Compatibility: {@code MediaSizeName} is a representation class for * values of the IPP "media" attribute which names media sizes. The names of the * media sizes correspond to those in the IPP 1.1 RFC - * RFC 2911 + * RFC 2911 * * @spec https://www.rfc-editor.org/info/rfc2911 * RFC 2911: Internet Printing Protocol/1.1: Model and Semantics diff --git a/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java b/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java index 77bf66afcf89f..31f4b17366cf6 100644 --- a/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java +++ b/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java @@ -77,7 +77,7 @@ * based on the Internet Printing Protocol (IPP) attributes as defined in the * Internet RFC document, RFC 2911 Internet Printing Protocol/1.1: Model and * Semantics dated September 2000. See - * RFC 2911 for more + * RFC 2911 for more * information. The descriptive text for each attribute class was taken largely * from the above documents. The above authors' contribution to the API is * gratefully acknowledged. diff --git a/src/java.desktop/share/classes/javax/print/package-info.java b/src/java.desktop/share/classes/javax/print/package-info.java index aabd1e6958e31..5bae67c58eb73 100644 --- a/src/java.desktop/share/classes/javax/print/package-info.java +++ b/src/java.desktop/share/classes/javax/print/package-info.java @@ -59,7 +59,7 @@ * {@code javax.print.attribute.standard} package enumerates all of the standard * attributes supported by the API, most of which are implementations of * attributes specified in the IETF Specification, - * RFC 2911 Internet Printing + * RFC 2911 Internet Printing * Protocol, 1.1: Model and Semantics, dated September 2000. The attributes * specified in {@code javax.print.attribute.standard} include common * capabilities, such as: resolution, copies, media sizes, job priority, and diff --git a/src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java b/src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java index 8e9d5afcba2dc..357ad3be43f1f 100644 --- a/src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java +++ b/src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java @@ -32,7 +32,7 @@ import java.awt.Color; /** PNG - Portable Network Graphics - image file reader. - See RFC2083 for details. */ + See RFC2083 for details. */ public class PNGImageDecoder extends ImageDecoder { private static final int GRAY=0;