changeset 60820:55db80785046

8242230: Whitespace typos, relaxed javadoc, formatting Reviewed-by: darcy, igerasim
author prappo
date Wed, 08 Apr 2020 11:16:56 +0100
parents fcbb67d1ebeb
children f275c9540215
files src/java.base/share/classes/java/io/DataOutput.java src/java.base/share/classes/java/lang/Character.java src/java.base/share/classes/java/lang/Class.java src/java.base/share/classes/java/lang/FdLibm.java src/java.base/share/classes/java/lang/Runtime.java src/java.base/share/classes/java/lang/String.java src/java.base/share/classes/java/lang/System.java src/java.base/share/classes/java/lang/annotation/ElementType.java src/java.base/share/classes/java/lang/annotation/Target.java src/java.base/share/classes/java/lang/reflect/Parameter.java src/java.base/share/classes/java/math/BigDecimal.java src/java.base/share/classes/java/math/BigInteger.java src/java.base/share/classes/java/net/MulticastSocket.java src/java.base/share/classes/java/text/DecimalFormatSymbols.java src/java.base/share/classes/java/util/Calendar.java src/java.base/share/classes/java/util/Formatter.java src/java.base/share/classes/jdk/internal/reflect/Reflection.java src/java.compiler/share/classes/javax/lang/model/util/Elements.java src/java.logging/share/classes/java/util/logging/Formatter.java
diffstat 19 files changed, 52 insertions(+), 53 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.base/share/classes/java/io/DataOutput.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/io/DataOutput.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1995, 2020, 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
@@ -113,8 +113,8 @@
     void writeBoolean(boolean v) throws IOException;
 
     /**
-     * Writes to the output stream the eight low-
-     * order bits of the argument {@code v}.
+     * Writes to the output stream the eight low-order
+     * bits of the argument {@code v}.
      * The 24 high-order bits of {@code v}
      * are ignored. (This means  that {@code writeByte}
      * does exactly the same thing as {@code write}
@@ -140,7 +140,7 @@
      * }</pre> <p>
      * The bytes written by this method may be
      * read by the {@code readShort} method
-     * of interface {@code DataInput} , which
+     * of interface {@code DataInput}, which
      * will then return a {@code short} equal
      * to {@code (short)v}.
      *
@@ -161,7 +161,7 @@
      * }</pre><p>
      * The bytes written by this method may be
      * read by the {@code readChar} method
-     * of interface {@code DataInput} , which
+     * of interface {@code DataInput}, which
      * will then return a {@code char} equal
      * to {@code (char)v}.
      *
@@ -183,7 +183,7 @@
      * }</pre><p>
      * The bytes written by this method may be read
      * by the {@code readInt} method of interface
-     * {@code DataInput} , which will then
+     * {@code DataInput}, which will then
      * return an {@code int} equal to {@code v}.
      *
      * @param      v   the {@code int} value to be written.
@@ -208,7 +208,7 @@
      * }</pre><p>
      * The bytes written by this method may be
      * read by the {@code readLong} method
-     * of interface {@code DataInput} , which
+     * of interface {@code DataInput}, which
      * will then return a {@code long} equal
      * to {@code v}.
      *
@@ -343,7 +343,7 @@
      * string {@code s} is written.<p>  The
      * bytes written by this method may be read
      * by the {@code readUTF} method of interface
-     * {@code DataInput} , which will then
+     * {@code DataInput}, which will then
      * return a {@code String} equal to {@code s}.
      *
      * @param      s   the string value to be written.
--- a/src/java.base/share/classes/java/lang/Character.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/Character.java	Wed Apr 08 11:16:56 2020 +0100
@@ -242,7 +242,7 @@
      * General category "Nd" in the Unicode specification.
      * @since   1.1
      */
-    public static final byte DECIMAL_DIGIT_NUMBER        = 9;
+    public static final byte DECIMAL_DIGIT_NUMBER = 9;
 
     /**
      * General category "Nl" in the Unicode specification.
@@ -11072,7 +11072,7 @@
      * Note: if the specified character is not assigned a name by
      * the <i>UnicodeData</i> file (part of the Unicode Character
      * Database maintained by the Unicode Consortium), the returned
-     * name is the same as the result of expression.
+     * name is the same as the result of expression:
      *
      * <blockquote>{@code
      *     Character.UnicodeBlock.of(codePoint).toString().replace('_', ' ')
@@ -11116,7 +11116,7 @@
      * <p>
      * Note: if a character is not assigned a name by the <i>UnicodeData</i>
      * file (part of the Unicode Character Database maintained by the Unicode
-     * Consortium), its name is defined as the result of expression
+     * Consortium), its name is defined as the result of expression:
      *
      * <blockquote>{@code
      *     Character.UnicodeBlock.of(codePoint).toString().replace('_', ' ')
--- a/src/java.base/share/classes/java/lang/Class.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/Class.java	Wed Apr 08 11:16:56 2020 +0100
@@ -144,7 +144,7 @@
  * For example:
  *
  * <blockquote>
- *     {@code System.out.println("The name of class Foo is: "+Foo.class.getName());}
+ *     {@code System.out.println("The name of class Foo is: " + Foo.class.getName());}
  * </blockquote>
  *
  * @param <T> the type of the class modeled by this {@code Class}
@@ -207,7 +207,7 @@
      * The string is formatted as a list of type modifiers, if any,
      * followed by the kind of type (empty string for primitive types
      * and {@code class}, {@code enum}, {@code interface},
-     * <code>&#64;</code>{@code interface}, or {@code record} as appropriate), followed
+     * {@code @interface}, or {@code record} as appropriate), followed
      * by the type's name, followed by an angle-bracketed
      * comma-separated list of the type's type parameters, if any,
      * including informative bounds on the type parameters, if any.
--- a/src/java.base/share/classes/java/lang/FdLibm.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/FdLibm.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2020, 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
@@ -237,8 +237,8 @@
             // floating-point divide.  Splitting a floating-point
             // number into non-overlapping portions can be
             // accomplished by judicious use of multiplies and
-            // additions. For details see T. J. Dekker, A Floating
-            // Point Technique for Extending the Available Precision ,
+            // additions. For details see T. J. Dekker, A Floating-Point
+            // Technique for Extending the Available Precision,
             // Numerische Mathematik, vol. 18, 1971, pp.224-242 and
             // subsequent work.
 
--- a/src/java.base/share/classes/java/lang/Runtime.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/Runtime.java	Wed Apr 08 11:16:56 2020 +0100
@@ -757,8 +757,8 @@
      * for more details.
      *
      * Otherwise, the libname argument is loaded from a system library
-     * location and mapped to a native library image in an implementation-
-     * dependent manner.
+     * location and mapped to a native library image in an
+     * implementation-dependent manner.
      * <p>
      * First, if there is a security manager, its {@code checkLink}
      * method is called with the {@code libname} as its argument.
--- a/src/java.base/share/classes/java/lang/String.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/String.java	Wed Apr 08 11:16:56 2020 +0100
@@ -2063,9 +2063,9 @@
      * <blockquote>
      * <code>
      * {@link java.util.regex.Pattern}.{@link
-     * java.util.regex.Pattern#compile compile}(<i>regex</i>).{@link
+     * java.util.regex.Pattern#compile(String) compile}(<i>regex</i>).{@link
      * java.util.regex.Pattern#matcher(java.lang.CharSequence) matcher}(<i>str</i>).{@link
-     * java.util.regex.Matcher#replaceFirst replaceFirst}(<i>repl</i>)
+     * java.util.regex.Matcher#replaceFirst(String) replaceFirst}(<i>repl</i>)
      * </code>
      * </blockquote>
      *
@@ -2108,9 +2108,9 @@
      * <blockquote>
      * <code>
      * {@link java.util.regex.Pattern}.{@link
-     * java.util.regex.Pattern#compile compile}(<i>regex</i>).{@link
+     * java.util.regex.Pattern#compile(String) compile}(<i>regex</i>).{@link
      * java.util.regex.Pattern#matcher(java.lang.CharSequence) matcher}(<i>str</i>).{@link
-     * java.util.regex.Matcher#replaceAll replaceAll}(<i>repl</i>)
+     * java.util.regex.Matcher#replaceAll(String) replaceAll}(<i>repl</i>)
      * </code>
      * </blockquote>
      *
@@ -2275,7 +2275,7 @@
      * <blockquote>
      * <code>
      * {@link java.util.regex.Pattern}.{@link
-     * java.util.regex.Pattern#compile compile}(<i>regex</i>).{@link
+     * java.util.regex.Pattern#compile(String) compile}(<i>regex</i>).{@link
      * java.util.regex.Pattern#split(java.lang.CharSequence,int) split}(<i>str</i>,&nbsp;<i>n</i>)
      * </code>
      * </blockquote>
--- a/src/java.base/share/classes/java/lang/System.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/System.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1863,8 +1863,8 @@
      * for more details.
      *
      * Otherwise, the libname argument is loaded from a system library
-     * location and mapped to a native library image in an implementation-
-     * dependent manner.
+     * location and mapped to a native library image in an
+     * implementation-dependent manner.
      * <p>
      * The call {@code System.loadLibrary(name)} is effectively
      * equivalent to the call
--- a/src/java.base/share/classes/java/lang/annotation/ElementType.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/annotation/ElementType.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, 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,8 +33,8 @@
  * given type.
  *
  * <p>The syntactic locations where annotations may appear are split into
- * <em>declaration contexts</em> , where annotations apply to declarations, and
- * <em>type contexts</em> , where annotations apply to types used in
+ * <em>declaration contexts</em>, where annotations apply to declarations, and
+ * <em>type contexts</em>, where annotations apply to types used in
  * declarations and expressions.
  *
  * <p>The constants {@link #ANNOTATION_TYPE}, {@link #CONSTRUCTOR}, {@link
--- a/src/java.base/share/classes/java/lang/annotation/Target.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/annotation/Target.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, 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
@@ -32,7 +32,7 @@
  * constants of {@link ElementType java.lang.annotation.ElementType}.
  *
  * <p>If an {@code @Target} meta-annotation is not present on an annotation type
- * {@code T} , then an annotation of type {@code T} may be written as a
+ * {@code T}, then an annotation of type {@code T} may be written as a
  * modifier for any declaration except a type parameter declaration.
  *
  * <p>If an {@code @Target} meta-annotation is present, the compiler will enforce
--- a/src/java.base/share/classes/java/lang/reflect/Parameter.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/lang/reflect/Parameter.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2020, 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
@@ -111,7 +111,7 @@
      * Returns a string describing this parameter.  The format is the
      * modifiers for the parameter, if any, in canonical order as
      * recommended by <cite>The Java&trade; Language
-     * Specification</cite>, followed by the fully- qualified type of
+     * Specification</cite>, followed by the fully-qualified type of
      * the parameter (excluding the last [] if the parameter is
      * variable arity), followed by "..." if the parameter is variable
      * arity, followed by a space, followed by the name of the
--- a/src/java.base/share/classes/java/math/BigDecimal.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/math/BigDecimal.java	Wed Apr 08 11:16:56 2020 +0100
@@ -104,7 +104,7 @@
  * determines how any discarded trailing digits affect the returned
  * result.
  *
- * <p>For all arithmetic operators , the operation is carried out as
+ * <p>For all arithmetic operators, the operation is carried out as
  * though an exact intermediate result were first calculated and then
  * rounded to the number of digits specified by the precision setting
  * (if necessary), using the selected rounding mode.  If the exact
--- a/src/java.base/share/classes/java/math/BigInteger.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/math/BigInteger.java	Wed Apr 08 11:16:56 2020 +0100
@@ -80,8 +80,8 @@
  * inclusive.
  *
  * <p>Bit operations operate on a single bit of the two's-complement
- * representation of their operand.  If necessary, the operand is sign-
- * extended so that it contains the designated bit.  None of the single-bit
+ * representation of their operand.  If necessary, the operand is sign-extended
+ * so that it contains the designated bit.  None of the single-bit
  * operations can produce a BigInteger with a different sign from the
  * BigInteger being operated on, as they affect only a single bit, and the
  * arbitrarily large abstraction provided by this class ensures that conceptually
--- a/src/java.base/share/classes/java/net/MulticastSocket.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/net/MulticastSocket.java	Wed Apr 08 11:16:56 2020 +0100
@@ -698,8 +698,8 @@
     }
 
     /**
-     * Sends a datagram packet to the destination, with a TTL (time-
-     * to-live) other than the default for the socket.  This method
+     * Sends a datagram packet to the destination, with a TTL (time-to-live)
+     * other than the default for the socket.  This method
      * need only be used in instances where a particular TTL is desired;
      * otherwise it is preferable to set a TTL once on the socket, and
      * use that default TTL for all packets.  This method does <B>not
--- a/src/java.base/share/classes/java/text/DecimalFormatSymbols.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/text/DecimalFormatSymbols.java	Wed Apr 08 11:16:56 2020 +0100
@@ -904,7 +904,7 @@
      * the same as {@code decimalSeparator} and {@code exponential}
      * to be 'E'.
      * If {@code serialVersionOnStream} is less than 2,
-     * initializes {@code locale}to the root locale, and initializes
+     * initializes {@code locale} to the root locale, and initializes
      * If {@code serialVersionOnStream} is less than 3, it initializes
      * {@code exponentialSeparator} using {@code exponential}.
      * If {@code serialVersionOnStream} is less than 4, it initializes
--- a/src/java.base/share/classes/java/util/Calendar.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/util/Calendar.java	Wed Apr 08 11:16:56 2020 +0100
@@ -235,7 +235,7 @@
  * originally set to August 31, 1999. Calling <code>set(Calendar.MONTH,
  * Calendar.SEPTEMBER)</code> sets the date to September 31,
  * 1999. This is a temporary internal representation that resolves to
- * October 1, 1999 if {@code getTime()}is then called. However, a
+ * October 1, 1999 if {@code getTime()} is then called. However, a
  * call to {@code set(Calendar.DAY_OF_MONTH, 30)} before the call to
  * {@code getTime()} sets the date to September 30, 1999, since
  * no recomputation occurs after {@code set()} itself.</p>
--- a/src/java.base/share/classes/java/util/Formatter.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/java/util/Formatter.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, 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
@@ -767,7 +767,7 @@
  *     {@code toString()} method.
  *
  *     <p> If the {@code '#'} flag is given and the argument is not a {@link
- *     Formattable} , then a {@link FormatFlagsConversionMismatchException}
+ *     Formattable}, then a {@link FormatFlagsConversionMismatchException}
  *     will be thrown.
  *
  * <tr><th scope="row" style="vertical-align:top"> {@code 'S'}
--- a/src/java.base/share/classes/jdk/internal/reflect/Reflection.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.base/share/classes/jdk/internal/reflect/Reflection.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2020, 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
@@ -207,7 +207,7 @@
     /*
      * Verify if a member is public and memberClass is a public type
      * in a package that is unconditionally exported and
-     * return {@code true}if it is granted.
+     * return {@code true} if it is granted.
      *
      * @param memberClass the declaring class of the member being accessed
      * @param modifiers the member's access modifiers
--- a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java	Wed Apr 08 11:16:56 2020 +0100
@@ -25,7 +25,6 @@
 
 package javax.lang.model.util;
 
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -246,13 +245,13 @@
      * comment of an element.
      *
      * <p> A documentation comment of an element is a comment that
-     * begins with "{@code /**}" , ends with a separate
+     * begins with "{@code /**}", ends with a separate
      * "<code>*&#47;</code>", and immediately precedes the element,
      * ignoring white space.  Therefore, a documentation comment
-     * contains at least three"{@code *}" characters.  The text
+     * contains at least three "{@code *}" characters.  The text
      * returned for the documentation comment is a processed form of
-     * the comment as it appears in source code.  The leading "{@code
-     * /**}" and trailing "<code>*&#47;</code>" are removed.  For lines
+     * the comment as it appears in source code.  The leading "{@code /**}"
+     * and trailing "<code>*&#47;</code>" are removed.  For lines
      * of the comment starting after the initial "{@code /**}",
      * leading white space characters are discarded as are any
      * consecutive "{@code *}" characters appearing after the white
@@ -382,7 +381,7 @@
          */
         EXPLICIT,
 
-       /**
+        /**
          * A mandated construct is one that is not explicitly declared
          * in the source code, but whose presence is mandated by the
          * specification. Such a construct is said to be implicitly
@@ -403,7 +402,7 @@
          */
         MANDATED,
 
-       /**
+        /**
          * A synthetic construct is one that is neither implicitly nor
          * explicitly declared in the source code. Such a construct is
          * typically a translation artifact created by a compiler.
@@ -414,8 +413,8 @@
          * Returns {@code true} for values corresponding to constructs
          * that are implicitly or explicitly declared, {@code false}
          * otherwise.
-         * @return {@code true} for {@link EXPLICIT} and {@link
-         * MANDATED}, {@code false} otherwise.
+         * @return {@code true} for {@link #EXPLICIT} and {@link #MANDATED},
+         *         {@code false} otherwise.
          */
         public boolean isDeclared() {
             return this != SYNTHETIC;
--- a/src/java.logging/share/classes/java/util/logging/Formatter.java	Wed Apr 08 10:31:58 2020 +0100
+++ b/src/java.logging/share/classes/java/util/logging/Formatter.java	Wed Apr 08 11:16:56 2020 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2020, 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