mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-27 06:45:07 +02:00
8199176: Accessibility issues in java.base docs
Reviewed-by: lancea, alanb, jjg, rriggs
This commit is contained in:
parent
87e7768a1c
commit
dd67e0fa16
10 changed files with 49 additions and 51 deletions
|
@ -1140,7 +1140,7 @@ public class Runtime {
|
|||
* number is not the major-release number but the feature-release
|
||||
* counter, incremented for every time-based release. Use the {@link
|
||||
* #feature()} method in preference to this method. For compatibility,
|
||||
* this method returns the value of the <a href="FEATURE">feature</a>
|
||||
* this method returns the value of the <a href="#FEATURE">feature</a>
|
||||
* element.
|
||||
*
|
||||
* @return The value of the feature element
|
||||
|
@ -1158,7 +1158,7 @@ public class Runtime {
|
|||
* number is not the minor-release number but the interim-release
|
||||
* counter, incremented for every interim release. Use the {@link
|
||||
* #interim()} method in preference to this method. For compatibility,
|
||||
* this method returns the value of the <a href="INTERIM">interim</a>
|
||||
* this method returns the value of the <a href="#INTERIM">interim</a>
|
||||
* element, or zero if it is absent.
|
||||
*
|
||||
* @return The value of the interim element, or zero
|
||||
|
@ -1176,7 +1176,7 @@ public class Runtime {
|
|||
* number is not the security level but the update-release counter,
|
||||
* incremented for every update release. Use the {@link #update()}
|
||||
* method in preference to this method. For compatibility, this method
|
||||
* returns the value of the <a href="UPDATE">update</a> element, or
|
||||
* returns the value of the <a href="#UPDATE">update</a> element, or
|
||||
* zero if it is absent.
|
||||
*
|
||||
* @return The value of the update element, or zero
|
||||
|
@ -1188,9 +1188,9 @@ public class Runtime {
|
|||
|
||||
/**
|
||||
* Returns an unmodifiable {@link java.util.List List} of the integers
|
||||
* represented in the <a href="#verNum">version number</a>. The {@code
|
||||
* List} always contains at least one element corresponding to the <a
|
||||
* href="#feature">feature version number</a>.
|
||||
* represented in the <a href="#verNum">version number</a>.
|
||||
* The {@code List} always contains at least one element corresponding to
|
||||
* the <a href="#FEATURE">feature version number</a>.
|
||||
*
|
||||
* @return An unmodifiable list of the integers
|
||||
* represented in the version number
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1998, 2018, 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
|
||||
|
@ -58,7 +58,7 @@
|
|||
* represent errors and exceptions.
|
||||
*
|
||||
* <a id="charenc"></a>
|
||||
* <h3>Character Encodings</h3>
|
||||
* <h2>Character Encodings</h2>
|
||||
*
|
||||
* The specification of the {@link java.nio.charset.Charset
|
||||
* java.nio.charset.Charset} class describes the naming conventions
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2007, 2018, 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
|
||||
|
@ -33,7 +33,7 @@
|
|||
* package is used by service provider implementors wishing to extend the
|
||||
* platform default provider, or to construct other provider implementations. </p>
|
||||
*
|
||||
* <h3><a id="links">Symbolic Links</a></h3>
|
||||
* <h2><a id="links">Symbolic Links</a></h2>
|
||||
* <p> Many operating systems and file systems support for <em>symbolic links</em>.
|
||||
* A symbolic link is a special file that serves as a reference to another file.
|
||||
* For the most part, symbolic links are transparent to applications and
|
||||
|
@ -45,7 +45,7 @@
|
|||
* that are semantically close but support for these other types of links is
|
||||
* not included in this package. </p>
|
||||
*
|
||||
* <h3><a id="interop">Interoperability</a></h3>
|
||||
* <h2><a id="interop">Interoperability</a></h2>
|
||||
* <p> The {@link java.io.File} class defines the {@link java.io.File#toPath
|
||||
* toPath} method to construct a {@link java.nio.file.Path} by converting
|
||||
* the abstract path represented by the {@code java.io.File} object. The resulting
|
||||
|
@ -54,7 +54,7 @@
|
|||
* on the <a href="Path.html#interop">interoperability</a> between {@code Path}
|
||||
* and {@code java.io.File} objects. </p>
|
||||
*
|
||||
* <h3>Visibility</h3>
|
||||
* <h2>Visibility</h2>
|
||||
* <p> The view of the files and file system provided by classes in this package are
|
||||
* guaranteed to be consistent with other views provided by other instances in the
|
||||
* same Java virtual machine. The view may or may not, however, be consistent with
|
||||
|
@ -65,7 +65,7 @@
|
|||
* or on some other machine. The exact nature of any such inconsistencies are
|
||||
* system-dependent and are therefore unspecified. </p>
|
||||
*
|
||||
* <h3><a id="integrity">Synchronized I/O File Integrity</a></h3>
|
||||
* <h2><a id="integrity">Synchronized I/O File Integrity</a></h2>
|
||||
* <p> The {@link java.nio.file.StandardOpenOption#SYNC SYNC} and {@link
|
||||
* java.nio.file.StandardOpenOption#DSYNC DSYNC} options are used when opening a file
|
||||
* to require that updates to the file are written synchronously to the underlying
|
||||
|
@ -82,7 +82,7 @@
|
|||
* java.nio.file.spi.FileSystemProvider provider} implementations is provider
|
||||
* specific. </p>
|
||||
*
|
||||
* <h3>General Exceptions</h3>
|
||||
* <h2>General Exceptions</h2>
|
||||
* <p> Unless otherwise noted, passing a {@code null} argument to a constructor
|
||||
* or method of any class or interface in this package will cause a {@link
|
||||
* java.lang.NullPointerException NullPointerException} to be thrown. Additionally,
|
||||
|
@ -103,7 +103,7 @@
|
|||
* provider} with a parameter that is an object created by another provider,
|
||||
* will throw {@link java.nio.file.ProviderMismatchException}. </p>
|
||||
*
|
||||
* <h3>Optional Specific Exceptions</h3>
|
||||
* <h2>Optional Specific Exceptions</h2>
|
||||
* Most of the methods defined by classes in this package that access the
|
||||
* file system specify that {@link java.io.IOException} be thrown when an I/O
|
||||
* error occurs. In some cases, these methods define specific I/O exceptions
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 2018, 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
|
||||
|
@ -95,7 +95,7 @@
|
|||
* <li>{@link java.time.chrono.ThaiBuddhistChronology Thai Buddhist calendar}</li>
|
||||
* </ul>
|
||||
*
|
||||
* <h3>Example</h3>
|
||||
* <h2>Example</h2>
|
||||
* <p>
|
||||
* This example lists todays date for all of the available calendars.
|
||||
* </p>
|
||||
|
@ -155,7 +155,7 @@
|
|||
* first, last);
|
||||
* </pre>
|
||||
*
|
||||
* <h3>Package specification</h3>
|
||||
* <h2>Package specification</h2>
|
||||
* <p>
|
||||
* Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
|
||||
* in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 2018, 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
|
||||
|
@ -79,7 +79,7 @@
|
|||
* {@link java.time.format.DecimalStyle DecimalStyle}.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Package specification</h3>
|
||||
* <h2>Package specification</h2>
|
||||
* <p>
|
||||
* Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
|
||||
* in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 2018, 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
|
||||
|
@ -90,7 +90,7 @@
|
|||
* The calendar neutral API should be reserved for interactions with users.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Dates and Times</h3>
|
||||
* <h2>Dates and Times</h2>
|
||||
* <p>
|
||||
* {@link java.time.Instant} is essentially a numeric timestamp.
|
||||
* The current Instant can be retrieved from a {@link java.time.Clock}.
|
||||
|
@ -118,7 +118,7 @@
|
|||
* The widespread use of time-zones tends to add considerable complexity to an application.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Duration and Period</h3>
|
||||
* <h2>Duration and Period</h2>
|
||||
* <p>
|
||||
* Beyond dates and times, the API also allows the storage of periods and durations of time.
|
||||
* A {@link java.time.Duration} is a simple measure of time along the time-line in nanoseconds.
|
||||
|
@ -126,7 +126,7 @@
|
|||
* to humans, such as years or days.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Additional value types</h3>
|
||||
* <h2>Additional value types</h2>
|
||||
* <p>
|
||||
* {@link java.time.Month} stores a month on its own.
|
||||
* This stores a single month-of-year in isolation, such as 'DECEMBER'.
|
||||
|
@ -160,7 +160,7 @@
|
|||
* but contains less information than a full time-zone.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Package specification</h3>
|
||||
* <h2>Package specification</h2>
|
||||
* <p>
|
||||
* Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
|
||||
* in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
@ -172,7 +172,7 @@
|
|||
* or a {@link java.time.DateTimeException}.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Design notes (non normative)</h3>
|
||||
* <h2>Design notes (non normative)</h2>
|
||||
* <p>
|
||||
* The API has been designed to reject null early and to be clear about this behavior.
|
||||
* A key exception is any method that takes an object and returns a boolean, for the purpose
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 2018, 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
|
||||
|
@ -75,7 +75,7 @@
|
|||
* <li>Different definitions of weeks</li>
|
||||
* </ul>
|
||||
*
|
||||
* <h3>Fields and Units</h3>
|
||||
* <h2>Fields and Units</h2>
|
||||
* <p>
|
||||
* Dates and times are expressed in terms of fields and units.
|
||||
* A unit is used to measure an amount of time, such as years, days or minutes.
|
||||
|
@ -106,7 +106,7 @@
|
|||
* The fields also provide access to the range of valid values.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Adjustment and Query</h3>
|
||||
* <h2>Adjustment and Query</h2>
|
||||
* <p>
|
||||
* A key part of the date-time problem space is adjusting a date to a new, related value,
|
||||
* such as the "last day of the month", or "next Wednesday".
|
||||
|
@ -131,7 +131,7 @@
|
|||
* Applications can also define queries by implementing {@link java.time.temporal.TemporalQuery}.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Weeks</h3>
|
||||
* <h2>Weeks</h2>
|
||||
* <p>
|
||||
* Different locales have different definitions of the week.
|
||||
* For example, in Europe the week typically starts on a Monday, while in the US it starts on a Sunday.
|
||||
|
@ -143,7 +143,7 @@
|
|||
* This is modeled in {@link java.time.temporal.IsoFields}.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Package specification</h3>
|
||||
* <h2>Package specification</h2>
|
||||
* <p>
|
||||
* Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
|
||||
* in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 2018, 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
|
||||
|
@ -70,7 +70,7 @@
|
|||
* gaps and overlaps in the local time-line typically caused by Daylight Saving Time.
|
||||
* </p>
|
||||
*
|
||||
* <h3>Package specification</h3>
|
||||
* <h2>Package specification</h2>
|
||||
* <p>
|
||||
* Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
|
||||
* in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue