From 34f0a6ec6a7d52630e8d6661f9d081abcf57b84a Mon Sep 17 00:00:00 2001 From: Jonathan Gibbons Date: Thu, 8 Jun 2023 19:00:19 +0000 Subject: [PATCH] 8305593: Add @spec tags in java.desktop Reviewed-by: prr --- src/java.desktop/share/classes/java/awt/Desktop.java | 4 +++- .../share/classes/java/awt/package-info.java | 4 ++-- .../share/classes/java/awt/peer/DesktopPeer.java | 5 ++++- .../imageio/metadata/doc-files/tiff_metadata.html | 4 ++-- .../imageio/plugins/tiff/BaselineTIFFTagSet.java | 3 ++- .../javax/imageio/plugins/tiff/FaxTIFFTagSet.java | 4 +++- .../share/classes/javax/print/DocFlavor.java | 12 +++++++++--- .../share/classes/javax/print/MimeType.java | 8 ++++++-- .../javax/print/attribute/standard/Compression.java | 4 +++- .../javax/print/attribute/standard/Fidelity.java | 5 ++++- .../print/attribute/standard/MediaSizeName.java | 5 ++++- .../javax/print/attribute/standard/package-info.java | 4 +++- .../share/classes/javax/print/package-info.java | 4 +++- .../share/classes/javax/swing/JEditorPane.java | 2 ++ .../share/classes/javax/swing/text/html/CSS.java | 1 + .../classes/javax/swing/text/html/package-info.java | 1 + .../share/classes/sun/awt/image/PNGImageDecoder.java | 2 +- 17 files changed, 53 insertions(+), 19 deletions(-) diff --git a/src/java.desktop/share/classes/java/awt/Desktop.java b/src/java.desktop/share/classes/java/awt/Desktop.java index e1dbb095ef6..1abba965d8b 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 class Desktop { *

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. * @@ -587,6 +587,8 @@ public class Desktop { * {@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 682a371dd83..8604fb3d078 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/java/awt/peer/DesktopPeer.java b/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java index 67eda40dd6c..c1b13a4e8f3 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 ee6b4a8fe10..38e23b85086 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 @@ supported compression types is listed in the following table: 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/BaselineTIFFTagSet.java b/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java index 340fe2aee77..be2cbf88c06 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 881df65993f..12d007f694d 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,8 +29,10 @@ import java.util.List; /** * 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 * @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 0e04dfb471c..448cc78d9e1 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 @@ import java.io.Serializable; * * * @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 16af07a7239..b1e7f1e89fc 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,9 @@ 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 */ 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 9d54a1794c9..b0e4b70c87c 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,8 +45,11 @@ import javax.print.attribute.PrintRequestAttribute; * 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 + * 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 63846f44156..f9dde495610 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,10 @@ import javax.print.attribute.EnumSyntax; * 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 */ 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 1cf8a257d1f..31f4b17366c 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. @@ -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 7334ac05655..5bae67c58eb 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 @@ -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 ee2f174206c..00e2db39556 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 @@ public class JEditorPane extends JTextComponent { * 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 8a2b94dd9cf..59ddf4856b2 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 @@ import javax.swing.text.View; * 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 68f709ff20c..8f32e2c41cf 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 */ 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 8e9d5afcba2..357ad3be43f 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.image.*; 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;