stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8305593: Add @spec tags in java.desktop

Browse Source 
Reviewed-by: prr
This commit is contained in:
Jonathan Gibbons 2023-06-08 19:00:19 +00:00
parent 0be39054a6
commit 34f0a6ec6a
17 changed files with 53 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/java.desktop/share/classes/java/awt/Desktop.java
View File

@ -569,7 +569,7 @@ public class Desktop {
* <p> A {@code mailto:} URI can specify message fields
* including <i>"to"</i>, <i>"cc"</i>, <i>"subject"</i>,
* <i>"body"</i>, etc. See <a
* href="http://www.ietf.org/rfc/rfc2368.txt">The mailto URL
* href="https://www.rfc-editor.org/info/rfc2368">The mailto URL
* scheme (RFC 2368)</a> 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
*/

4
src/java.desktop/share/classes/java/awt/package-info.java
View File

@ -54,10 +54,10 @@
* <ul>
* <li><a href="doc-files/FocusSpec.html">The AWT Focus Subsystem</a>
* <li><a href="doc-files/Modality.html">The AWT Modality</a>
* <li><a href="{@docRoot}/../specs/AWT_Native_Interface.html">
* The Java AWT Native Interface (JAWT)</a>
* </ul>
*
* @spec AWT_Native_Interface.html
* The Java AWT Native Interface Specification and Guide
* @since 1.0
*/
package java.awt;

5
src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java
View File

@ -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
* <a href="http://www.ietf.org/rfc/rfc2368.txt">RFC2368: The mailto
* <a href="https://www.rfc-editor.org/info/rfc2368">RFC2368: The mailto
* URL scheme</a>
* @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;

4
src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html
View File

@ -565,9 +565,9 @@ supported compression types is listed in the following table:
<th scope="row">8</th>
<td>Deflate</td>
<td>"Zip-in-TIFF" compression (see note following this table)</td>
<td><a href="https://tools.ietf.org/html/rfc1950">
<td><a href="https://www.rfc-editor.org/info/rfc1950">
ZLIB Compressed Data Format Specification</a>,
<a href="https://tools.ietf.org/html/rfc1951">
<a href="https://www.rfc-editor.org/info/rfc1951">
DEFLATE Compressed Data Format Specification</a></td>
</tr>
<tr>

3
src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java
View File

@ -222,7 +222,8 @@ public final class BaselineTIFFTagSet extends TIFFTagSet {
* A value to be used with the "Compression" tag.
*
* @see #TAG_COMPRESSION
* @see <a href="https://tools.ietf.org/html/rfc1951">DEFLATE specification</a>
* @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;

4
src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java
View File

@ -29,8 +29,10 @@ import java.util.List;
/**
* A class representing the extra tags found in a
* <a href="https://tools.ietf.org/html/rfc2306.html">TIFF-F</a> (RFC 2036) file.
* <a href="https://www.rfc-editor.org/info/rfc2306">TIFF-F</a> (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 {

12
src/java.desktop/share/classes/javax/print/DocFlavor.java
View File

@ -39,8 +39,8 @@ import java.io.Serializable;
* <ul>
* <li><b>MIME type.</b> This is a Multipurpose Internet Mail Extensions
* (MIME) media type (as defined in
* <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> and
* <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>) that specifies
* <a href="https://www.rfc-editor.org/info/rfc2045">RFC 2045</a> and
* <a href="https://www.rfc-editor.org/info/rfc2046">RFC 2046</a>) that specifies
* how the print data is to be interpreted. The charset of text data should be
* the IANA MIME-preferred name, or its canonical name if no preferred name is
* specified. Additionally a few historical names supported by earlier
@ -383,6 +383,10 @@ import java.io.Serializable;
* 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 {
@ -396,13 +400,15 @@ public class DocFlavor implements Serializable, Cloneable {
/**
* A string representing the host operating system encoding. This will
* follow the conventions documented in
* <a href="http://www.ietf.org/rfc/rfc2278.txt">
* <a href="https://www.rfc-editor.org/info/rfc2278">
* <i>RFC&nbsp;2278:&nbsp;IANA Charset Registration Procedures</i></a>
* except where historical names are returned for compatibility with
* previous versions of the Java platform. The value returned from method is
* 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 =

8
src/java.desktop/share/classes/javax/print/MimeType.java
View File

@ -38,8 +38,8 @@ import java.util.Set;
/**
* Class {@code MimeType} encapsulates a Multipurpose Internet Mail Extensions
* (MIME) media type as defined in
* <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> and
* <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>. A MIME type
* <a href="https://www.rfc-editor.org/info/rfc2045">RFC 2045</a> and
* <a href="https://www.rfc-editor.org/info/rfc2046">RFC 2046</a>. A MIME type
* object is part of a {@link DocFlavor DocFlavor} object and specifies the
* format of the print data.
* <p>
@ -74,6 +74,10 @@ import java.util.Set;
* </ul>
*
* @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 {

4
src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java
View File

@ -66,7 +66,9 @@ public class Compression extends EnumSyntax implements DocAttribute {
/**
* GNU zip compression technology described in
* <a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>.
* <a href="https://www.rfc-editor.org/info/rfc1952">RFC 1952</a>.
* @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);

5
src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java
View File

@ -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
* <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a> Section 15.1 for a
* <a href="https://www.rfc-editor.org/info/rfc2911">RFC 2911</a> 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 {

5
src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java
View File

@ -41,7 +41,10 @@ import javax.print.attribute.EnumSyntax;
* <b>IPP Compatibility:</b> {@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
* <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a>
* <a href="https://www.rfc-editor.org/info/rfc2911">RFC 2911</a>
*
* @spec https://www.rfc-editor.org/info/rfc2911
* RFC 2911: Internet Printing Protocol/1.1: Model and Semantics
*/
public class MediaSizeName extends Media {

4
src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java
View File

@ -77,7 +77,7 @@
* based on the Internet Printing Protocol (IPP) attributes as defined in the
* Internet RFC document, <i>RFC 2911 Internet Printing Protocol/1.1: Model and
* Semantics</i> dated September 2000. See
* <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a> for more
* <a href="https://www.rfc-editor.org/info/rfc2911">RFC 2911</a> 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;

4
src/java.desktop/share/classes/javax/print/package-info.java
View File

@ -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,
* <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911 Internet Printing
* <a href="https://www.rfc-editor.org/info/rfc2911">RFC 2911 Internet Printing
* Protocol, 1.1: Model and Semantics</a>, 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;

2
src/java.desktop/share/classes/javax/swing/JEditorPane.java
View File

@ -1615,6 +1615,8 @@ public class JEditorPane extends JTextComponent {
* it set the client {@link #putClientProperty property} with this name
* to <code>Boolean.TRUE</code>.
*
* @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";

1
src/java.desktop/share/classes/javax/swing/text/html/CSS.java
View File

@ -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.</b>
*
* @spec https://www.w3.org/TR/REC-CSS1 Cascading Style Sheets, level 1
* @author Timothy Prinzing
* @author Scott Violet
* @see StyleSheet

1
src/java.desktop/share/classes/javax/swing/text/html/package-info.java
View File

@ -43,6 +43,7 @@
* which HTMLEditorKit is based.
* </ul>
*
* @spec https://www.w3.org/TR/REC-html32.html HTML 3.2 Reference Specification
* @since 1.2
* @serial exclude
*/

2
src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java
View File

@ -32,7 +32,7 @@ import java.awt.image.*;
import java.awt.Color;
/** PNG - Portable Network Graphics - image file reader.
See <a href=http://www.ietf.org/rfc/rfc2083.txt>RFC2083</a> for details. */
See <a href="https://www.rfc-editor.org/info/rfc2083">RFC2083</a> for details. */
public class PNGImageDecoder extends ImageDecoder
{
private static final int GRAY=0;