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

8132478: [tidy] three new warnings from java docs (java.net, javax.annotation)

Browse Source 
Minor docs cleanup (jdk part)

Reviewed-by: lancea
This commit is contained in:
Alexander Stepanov 2015-08-18 18:04:17 +03:00
parent 4d4cf68fd9
commit 3ff6e41288
12 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
jdk/src/java.base/share/classes/java/lang/Shutdown.java
View File

@ -86,10 +86,10 @@ class Shutdown {
* to be registered even if the shutdown is in progress.
* @params hook the hook to be registered
*
* @throw IllegalStateException
* if registerShutdownInProgress is false and shutdown is in progress; or
* if registerShutdownInProgress is true and the shutdown process
* already passes the given slot
* @throws IllegalStateException
* if registerShutdownInProgress is false and shutdown is in progress; or
* if registerShutdownInProgress is true and the shutdown process
* already passes the given slot
*/
static void add(int slot, boolean registerShutdownInProgress, Runnable hook) {
synchronized (lock) {

2
jdk/src/java.base/share/classes/java/net/ContentHandler.java
View File

@ -47,7 +47,7 @@ import java.io.IOException;
* If no content handler could be {@linkplain URLConnection#getContent() found},
* URLConnection will look for a content handler in a user-definable set of places.
* Users can define a vertical-bar delimited set of class prefixes
* to search through by defining the <i>{@value java.net.URLConnection#contentPathProp}</i>
* to search through by defining the <i>{@link java.net.URLConnection#contentPathProp}</i>
* property. The class name must be of the form:
* <blockquote>
* <i>{package-prefix}.{major}.{minor}</i>

4
jdk/src/java.base/share/classes/java/nio/Buffer.java
View File

@ -215,8 +215,8 @@ public abstract class Buffer {
* {@code put(src)} when the parameter is the {@code Buffer} on which the
* method is being invoked.
*
* @returns IllegalArgumentException
* With a message indicating equal source and target buffers
* @return IllegalArgumentException
* With a message indicating equal source and target buffers
*/
static IllegalArgumentException createSameBufferException() {
return new IllegalArgumentException("The source buffer is this buffer");

4
jdk/src/java.base/share/classes/sun/net/www/protocol/http/NegotiateAuthentication.java
View File

@ -191,7 +191,7 @@ class NegotiateAuthentication extends AuthenticationInfo {
/**
* return the first token.
* @returns the token
* @return the token
* @throws IOException if <code>Negotiator.getNegotiator()</code> or
* <code>Negotiator.firstToken()</code> failed.
*/
@ -219,7 +219,7 @@ class NegotiateAuthentication extends AuthenticationInfo {
/**
* return more tokens
* @param token the token to be fed into <code>negotiator.nextToken()</code>
* @returns the token
* @return the token
* @throws IOException if <code>negotiator.nextToken()</code> throws Exception.
* May happen if the input token is invalid.
*/

4
jdk/src/java.base/share/classes/sun/reflect/annotation/AnnotationType.java
View File

@ -98,8 +98,8 @@ public class AnnotationType {
* Sole constructor.
*
* @param annotationClass the class object for the annotation type
* @throw IllegalArgumentException if the specified class object for
* does not represent a valid annotation type
* @throws IllegalArgumentException if the specified class object for
* does not represent a valid annotation type
*/
private AnnotationType(final Class<? extends Annotation> annotationClass) {
if (!annotationClass.isAnnotation())

2
jdk/src/java.base/share/classes/sun/util/CoreResourceBundleControl-XLocales.java.template
View File

@ -92,7 +92,7 @@ public class CoreResourceBundleControl extends ResourceBundle.Control {
}
/**
* @returns a list of candidate locales to search from.
* @return a list of candidate locales to search from.
* @exception NullPointerException if baseName or locale is null.
*/
@Override

2
jdk/src/java.base/share/classes/sun/util/resources/LocaleData.java
View File

@ -201,7 +201,7 @@ public class LocaleData {
*
* @param baseName the resource bundle base name.
* locale the requested locale for the resource bundle.
* @returns a list of candidate locales to search from.
* @return a list of candidate locales to search from.
* @exception NullPointerException if baseName or locale is null.
*/
@Override

2
jdk/src/java.management/share/classes/javax/management/InstanceOfQueryExp.java
View File

@ -65,7 +65,7 @@ class InstanceOfQueryExp extends QueryEval implements QueryExp {
/**
* Returns the class name.
* @returns The {@link StringValueExp} returning the name of
* @return The {@link StringValueExp} returning the name of
* the class of which selected MBeans should be instances.
*/
public StringValueExp getClassNameValue() {

2
jdk/src/java.naming/share/classes/com/sun/jndi/ldap/LdapCtx.java
View File

@ -909,7 +909,7 @@ final public class LdapCtx extends ComponentDirContext
* @param dn The non-null DN of the entry to add
* @param attrs The non-null attributes of entry to add
* @param directUpdate Whether attrs can be updated directly
* @returns Non-null attributes with attributes from the RDN added
* @return Non-null attributes with attributes from the RDN added
*/
private static Attributes addRdnAttributes(String dn, Attributes attrs,
boolean directUpdate) throws NamingException {

2
jdk/src/java.naming/share/classes/com/sun/jndi/ldap/ServiceLocator.java
View File

@ -62,7 +62,7 @@ class ServiceLocator {
*
* @param dn A string distinguished name (RFC 2253).
* @return A domain name or null if none can be derived.
* @throw InvalidNameException If the distinguished name is invalid.
* @throws InvalidNameException If the distinguished name is invalid.
*/
static String mapDnToDomainName(String dn) throws InvalidNameException {
if (dn == null) {

4
jdk/src/java.naming/share/classes/com/sun/jndi/ldap/ext/StartTlsResponseImpl.java
View File

@ -297,7 +297,7 @@ final public class StartTlsResponseImpl extends StartTlsResponse {
* Returns the default SSL socket factory.
*
* @return The default SSL socket factory.
* @throw IOException If TLS is not supported.
* @throws IOException If TLS is not supported.
*/
private SSLSocketFactory getDefaultFactory() throws IOException {
@ -314,7 +314,7 @@ final public class StartTlsResponseImpl extends StartTlsResponse {
*
* @param factory The SSL socket factory to use.
* @return The SSL socket.
* @throw IOException If an exception occurred while performing the
* @throws IOException If an exception occurred while performing the
* TLS handshake.
*/
private SSLSocket startHandshake(SSLSocketFactory factory)

14
jdk/src/java.prefs/share/classes/java/util/prefs/Base64.java
View File

@ -124,8 +124,8 @@ class Base64 {
* Translates the specified Base64 string (as per Preferences.get(byte[]))
* into a byte array.
*
* @throw IllegalArgumentException if {@code s} is not a valid Base64
* string.
* @throws IllegalArgumentException if {@code s} is not a valid Base64
* string.
*/
static byte[] base64ToByteArray(String s) {
return base64ToByteArray(s, false);
@ -135,9 +135,9 @@ class Base64 {
* Translates the specified "alternate representation" Base64 string
* into a byte array.
*
* @throw IllegalArgumentException or ArrayOutOfBoundsException
* if {@code s} is not a valid alternate representation
* Base64 string.
* @throws IllegalArgumentException or ArrayOutOfBoundsException
* if {@code s} is not a valid alternate representation
* Base64 string.
*/
static byte[] altBase64ToByteArray(String s) {
return base64ToByteArray(s, true);
@ -194,8 +194,8 @@ class Base64 {
* Translates the specified character, which is assumed to be in the
* "Base 64 Alphabet" into its equivalent 6-bit positive integer.
*
* @throw IllegalArgumentException or ArrayOutOfBoundsException if
* c is not in the Base64 Alphabet.
* @throws IllegalArgumentException or ArrayOutOfBoundsException if
* c is not in the Base64 Alphabet.
*/
private static int base64toInt(char c, byte[] alphaToInt) {
int result = alphaToInt[c];