changeset 14781:eb9249662bc2

8157322: Several typos in javadoc Reviewed-by: alexp, serb
author dmarkov
date Fri, 20 May 2016 10:48:48 +0300
parents 1e72fda41408
children db28db07924c
files src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterGraphicsConfig.java src/java.desktop/share/classes/com/sun/media/sound/AudioSynthesizerPropertyInfo.java src/java.desktop/share/classes/java/awt/GraphicsConfiguration.java src/java.desktop/share/classes/java/awt/font/TransformAttribute.java src/java.desktop/share/classes/java/awt/image/renderable/ParameterBlock.java src/java.desktop/share/classes/java/beans/Encoder.java src/java.desktop/share/classes/java/beans/PersistenceDelegate.java src/java.desktop/share/classes/javax/imageio/stream/ImageInputStream.java src/java.desktop/share/classes/javax/imageio/stream/ImageOutputStream.java src/java.desktop/share/classes/javax/sound/sampled/EnumControl.java src/java.desktop/share/classes/javax/sound/sampled/UnsupportedAudioFileException.java src/java.desktop/share/classes/javax/swing/BorderFactory.java src/java.desktop/share/classes/javax/swing/GroupLayout.java src/java.desktop/share/classes/javax/swing/LookAndFeel.java src/java.desktop/share/classes/javax/swing/event/AncestorListener.java src/java.desktop/share/classes/javax/swing/plaf/BorderUIResource.java
diffstat 16 files changed, 40 insertions(+), 42 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterGraphicsConfig.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterGraphicsConfig.java	Fri May 20 10:48:48 2016 +0300
@@ -166,8 +166,7 @@
     }
 
     /**
-     *
-     * Returns a {@code AffineTransform} that can be concatenated
+     * Returns an {@code AffineTransform} that can be concatenated
      * with the default {@code AffineTransform}
      * of a {@code GraphicsConfiguration} so that 72 units in user
      * space equals 1 inch in device space.
--- a/src/java.desktop/share/classes/com/sun/media/sound/AudioSynthesizerPropertyInfo.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/com/sun/media/sound/AudioSynthesizerPropertyInfo.java	Fri May 20 10:48:48 2016 +0300
@@ -32,7 +32,7 @@
 public final class AudioSynthesizerPropertyInfo {
 
     /**
-     * Constructs a {@code AudioSynthesizerPropertyInfo} object with a given
+     * Constructs an {@code AudioSynthesizerPropertyInfo} object with a given
      * name and value. The {@code description} and {@code choices}
      * are initialized by {@code null} values.
      *
--- a/src/java.desktop/share/classes/java/awt/GraphicsConfiguration.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/java/awt/GraphicsConfiguration.java	Fri May 20 10:48:48 2016 +0300
@@ -360,8 +360,7 @@
     public abstract AffineTransform getDefaultTransform();
 
     /**
-     *
-     * Returns a {@code AffineTransform} that can be concatenated
+     * Returns an {@code AffineTransform} that can be concatenated
      * with the default {@code AffineTransform}
      * of a {@code GraphicsConfiguration} so that 72 units in user
      * space equals 1 inch in device space.
--- a/src/java.desktop/share/classes/java/awt/font/TransformAttribute.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/java/awt/font/TransformAttribute.java	Fri May 20 10:48:48 2016 +0300
@@ -74,7 +74,7 @@
 
     /**
      * Returns a copy of the wrapped transform.
-     * @return a {@code AffineTransform} that is a copy of the wrapped
+     * @return an {@code AffineTransform} that is a copy of the wrapped
      * transform of this {@code TransformAttribute}.
      */
     public AffineTransform getTransform() {
--- a/src/java.desktop/share/classes/java/awt/image/renderable/ParameterBlock.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/java/awt/image/renderable/ParameterBlock.java	Fri May 20 10:48:48 2016 +0300
@@ -619,9 +619,9 @@
      *
      * @param index the index of the parameter to be returned.
      * @return the parameter at the specified index
-     *         as a {@code int} value.
+     *         as an {@code int} value.
      * @throws ClassCastException if the parameter at the
-     *         specified index is not a {@code Integer}
+     *         specified index is not an {@code Integer}
      * @throws NullPointerException if the parameter at the specified
      *         index is {@code null}
      * @throws ArrayIndexOutOfBoundsException if {@code index}
--- a/src/java.desktop/share/classes/java/beans/Encoder.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/java/beans/Encoder.java	Fri May 20 10:48:48 2016 +0300
@@ -136,7 +136,7 @@
      * a shared internal persistence delegate is returned
      * that encodes {@code null} value.
      * <li>
-     * If the type is a {@code enum} declaration,
+     * If the type is an {@code enum} declaration,
      * a shared internal persistence delegate is returned
      * that encodes constants of this enumeration
      * by their names.
--- a/src/java.desktop/share/classes/java/beans/PersistenceDelegate.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/java/beans/PersistenceDelegate.java	Fri May 20 10:48:48 2016 +0300
@@ -89,7 +89,7 @@
 
     /**
      * The {@code writeObject} is a single entry point to the persistence
-     * and is used by a {@code Encoder} in the traditional
+     * and is used by an {@code Encoder} in the traditional
      * mode of delegation. Although this method is not final,
      * it should not need to be subclassed under normal circumstances.
      * <p>
--- a/src/java.desktop/share/classes/javax/imageio/stream/ImageInputStream.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/imageio/stream/ImageInputStream.java	Fri May 20 10:48:48 2016 +0300
@@ -32,7 +32,7 @@
 
 /**
  * A seekable input stream interface for use by
- * {@code ImageReader}s.  Various input sources, such as
+ * {@code ImageReader}s. Various input sources, such as
  * {@code InputStream}s and {@code File}s,
  * as well as future fast I/O sources may be "wrapped" by a suitable
  * implementation of this interface for use by the Image I/O API.
@@ -469,7 +469,7 @@
      * then a {@code UTFDataFormatException} is thrown.
      *
      * <p> If end of file is encountered at any time during this
-     * entire process, then an {@code java.io.EOFException} is thrown.
+     * entire process, then a {@code java.io.EOFException} is thrown.
      *
      * <p> After every group has been converted to a character by this
      * process, the characters are gathered, in the same order in
@@ -499,7 +499,7 @@
     /**
      * Reads {@code len} bytes from the stream, and stores them
      * into {@code b} starting at index {@code off}.
-     * If the end of the stream is reached, an {@code java.io.EOFException}
+     * If the end of the stream is reached, a {@code java.io.EOFException}
      * will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
@@ -523,7 +523,7 @@
     /**
      * Reads {@code b.length} bytes from the stream, and stores them
      * into {@code b} starting at index {@code 0}.
-     * If the end of the stream is reached, an {@code java.io.EOFException}
+     * If the end of the stream is reached, a {@code java.io.EOFException}
      * will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
@@ -543,8 +543,8 @@
      * Reads {@code len} shorts (signed 16-bit integers) from the
      * stream according to the current byte order, and
      * stores them into {@code s} starting at index
-     * {@code off}.  If the end of the stream is reached, an
-     * {@code java.io.EOFException} will be thrown.
+     * {@code off}.  If the end of the stream is reached,
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -568,8 +568,8 @@
      * Reads {@code len} chars (unsigned 16-bit integers) from the
      * stream according to the current byte order, and
      * stores them into {@code c} starting at index
-     * {@code off}.  If the end of the stream is reached, an
-     * {@code java.io.EOFException} will be thrown.
+     * {@code off}.  If the end of the stream is reached,
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -593,8 +593,8 @@
      * Reads {@code len} ints (signed 32-bit integers) from the
      * stream according to the current byte order, and
      * stores them into {@code i} starting at index
-     * {@code off}.  If the end of the stream is reached, an
-     * {@code java.io.EOFException} will be thrown.
+     * {@code off}.  If the end of the stream is reached,
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -618,8 +618,8 @@
      * Reads {@code len} longs (signed 64-bit integers) from the
      * stream according to the current byte order, and
      * stores them into {@code l} starting at index
-     * {@code off}.  If the end of the stream is reached, an
-     * {@code java.io.EOFException} will be thrown.
+     * {@code off}.  If the end of the stream is reached,
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -644,7 +644,7 @@
      * floats) from the stream according to the current byte order,
      * and stores them into {@code f} starting at
      * index {@code off}.  If the end of the stream is reached,
-     * an {@code java.io.EOFException} will be thrown.
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -669,7 +669,7 @@
      * floats) from the stream according to the current byte order,
      * and stores them into {@code d} starting at
      * index {@code off}.  If the end of the stream is reached,
-     * an {@code java.io.EOFException} will be thrown.
+     * a {@code java.io.EOFException} will be thrown.
      *
      * <p> The bit offset within the stream is reset to zero before
      * the read occurs.
@@ -781,7 +781,7 @@
      * byte order is being used (i.e., {@code getByteOrder() == false}).
      *
      * <p> If the end of the stream is encountered before all the bits
-     * have been read, an {@code java.io.EOFException} is thrown.
+     * have been read, a {@code java.io.EOFException} is thrown.
      *
      * @param numBits the number of bits to read, as an {@code int}
      * between 0 and 64, inclusive.
@@ -848,8 +848,8 @@
      * {@code pos} is smaller than the flushed position (as
      * returned by {@code getflushedPosition}).
      *
-     * <p> It is legal to seek past the end of the file; an
-     * {@code java.io.EOFException} will be thrown only if a read is
+     * <p> It is legal to seek past the end of the file;
+     * a {@code java.io.EOFException} will be thrown only if a read is
      * performed.
      *
      * @param pos a {@code long} containing the desired file
--- a/src/java.desktop/share/classes/javax/imageio/stream/ImageOutputStream.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/imageio/stream/ImageOutputStream.java	Fri May 20 10:48:48 2016 +0300
@@ -44,7 +44,7 @@
  * a non-zero bit offset before a byte-aligned read.  When reading bytes,
  * any bit offset is set to 0 before the read; when writing bytes, a
  * non-zero bit offset causes the remaining bits in the byte to be written
- * as 0s.  The byte-aligned write then starts at the next byte position.
+ * as 0s. The byte-aligned write then starts at the next byte position.
  *
  * @see ImageInputStream
  *
@@ -290,7 +290,7 @@
     /**
      * Writes a {@code double} value, which is comprised of four
      * bytes, to the output stream. It does this as if it first
-     * converts this {@code double} value to an {@code long}
+     * converts this {@code double} value to a {@code long}
      * in exactly the manner of the
      * {@code Double.doubleToLongBits} method and then writes the
      * long value in exactly the manner of the {@code writeLong}
--- a/src/java.desktop/share/classes/javax/sound/sampled/EnumControl.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/sound/sampled/EnumControl.java	Fri May 20 10:48:48 2016 +0300
@@ -26,8 +26,8 @@
 package javax.sound.sampled;
 
 /**
- * A {@code EnumControl} provides control over a set of discrete possible values
- * , each represented by an object. In a graphical user interface, such a
+ * An {@code EnumControl} provides control over a set of discrete possible
+ * values, each represented by an object. In a graphical user interface, such a
  * control might be represented by a set of buttons, each of which chooses one
  * value or setting. For example, a reverb control might provide several preset
  * reverberation settings, instead of providing continuously adjustable
--- a/src/java.desktop/share/classes/javax/sound/sampled/UnsupportedAudioFileException.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/sound/sampled/UnsupportedAudioFileException.java	Fri May 20 10:48:48 2016 +0300
@@ -38,16 +38,16 @@
     private static final long serialVersionUID = -139127412623160368L;
 
     /**
-     * Constructs a {@code UnsupportedAudioFileException} that has {@code null}
-     * as its error detail message.
+     * Constructs an {@code UnsupportedAudioFileException} that has
+     * {@code null} as its error detail message.
      */
     public UnsupportedAudioFileException() {
         super();
     }
 
     /**
-     * Constructs a {@code UnsupportedAudioFileException} that has the specified
-     * detail message.
+     * Constructs an {@code UnsupportedAudioFileException} that has the
+     * specified detail message.
      *
      * @param  message a string containing the error detail message
      */
--- a/src/java.desktop/share/classes/javax/swing/BorderFactory.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/swing/BorderFactory.java	Fri May 20 10:48:48 2016 +0300
@@ -52,7 +52,7 @@
 
 //// LineBorder ///////////////////////////////////////////////////////////////
     /**
-     * Creates a line border withe the specified color.
+     * Creates a line border with the specified color.
      *
      * @param color  a <code>Color</code> to use for the line
      * @return the <code>Border</code> object
--- a/src/java.desktop/share/classes/javax/swing/GroupLayout.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/swing/GroupLayout.java	Fri May 20 10:48:48 2016 +0300
@@ -718,10 +718,10 @@
      * <p>
      * Linked {@code Component}s are not be resizable.
      *
-     * @param components the {@code Component}s that are to have the same size
      * @param axis the axis to link the size along; one of
      *             {@code SwingConstants.HORIZONTAL} or
-     *             {@code SwingConstans.VERTICAL}
+     *             {@code SwingConstants.VERTICAL}
+     * @param components the {@code Component}s that are to have the same size
      * @throws IllegalArgumentException if {@code components} is
      *         {@code null}, or contains {@code null}; or {@code axis}
      *          is not {@code SwingConstants.HORIZONTAL} or
--- a/src/java.desktop/share/classes/javax/swing/LookAndFeel.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/swing/LookAndFeel.java	Fri May 20 10:48:48 2016 +0300
@@ -346,7 +346,7 @@
     }
 
     /**
-     * Creates a {@code InputMapUIResource} from <code>keys</code>. This is
+     * Creates an {@code InputMapUIResource} from <code>keys</code>. This is
      * a convenience method for creating a new {@code InputMapUIResource},
      * invoking {@code loadKeyBindings(map, keys)}, and returning the
      * {@code InputMapUIResource}.
--- a/src/java.desktop/share/classes/javax/swing/event/AncestorListener.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/swing/event/AncestorListener.java	Fri May 20 10:48:48 2016 +0300
@@ -57,7 +57,7 @@
     /**
      * Called when the source or one of its ancestors is made invisible
      * either by setVisible(false) being called or by its being
-     * remove from the component hierarchy.  The method is only called
+     * removed from the component hierarchy.  The method is only called
      * if the source has actually become invisible.  For this to be true
      * at least one of its parents must by invisible or it is not in
      * a hierarchy rooted at a Window
--- a/src/java.desktop/share/classes/javax/swing/plaf/BorderUIResource.java	Thu May 19 16:45:58 2016 +0530
+++ b/src/java.desktop/share/classes/javax/swing/plaf/BorderUIResource.java	Fri May 20 10:48:48 2016 +0300
@@ -160,7 +160,7 @@
     public static class EmptyBorderUIResource extends EmptyBorder implements UIResource {
 
         /**
-         * Constructs a {@code EmptyBorderUIResource}.
+         * Constructs an {@code EmptyBorderUIResource}.
          * @param top the top inset of the border
          * @param left the left inset of the border
          * @param bottom the bottom inset of the border
@@ -170,7 +170,7 @@
             super(top, left, bottom, right);
         }
         /**
-         * Constructs a {@code EmptyBorderUIResource}.
+         * Constructs an {@code EmptyBorderUIResource}.
          * @param insets the insets of the border
          */
         @ConstructorProperties({"borderInsets"})