[cp-patches] Patch: FYI: warning fixes

[Tom Tromey]

I'm checking this in.

This mostly fixes some warnings related to javadoc but also a couple
related to unused imports.

It also adds a missing @since -- try to remember these, folks.

Tom

2005-09-13  Tom Tromey  <address@hidden>

        * java/lang/Process.java: Added import for javadoc.
        * java/lang/Object.java (notify): Javadoc fix.
        (notifyAll): Likewise.
        * java/io/PipedInputStream.java (connect): Javadoc fix.
        * java/io/OutputStreamWriter.java: Organized imports.
        * java/io/ObjectStreamField.java (setOffset): Javadoc fix.
        * java/io/ObjectInputStream.java (readFields): Javadoc fix.
        * java/io/DataOutputStream.java (writeChars): Javadoc fix.
        (writeFloat): Likewise.
        (writeDouble): Likewise.
        * java/util/Locale.java (readObject): Javadoc fix.
        (writeObject): Likewise.
        * java/io/LineNumberReader.java (read): Javadoc fix.
        (setLineNumber): Likewise.
        (mark): Likewise.
        * java/io/InputStreamReader.java: Updated imports.
        * java/lang/Integer.java (parseInt): Javadoc fix.
        * java/io/FilterReader.java (skip): Javadoc fix.
        * java/util/HashMap.java (containsValue): Javadoc fix.
        * java/lang/ClassLoader.java (findLibrary): Javadoc fix.
        (setPackageAssertionStatus): Likewise.
        (setClassAssertionStatus): Likewise.
        * java/lang/Class.java: Added imports for javadoc.
        (matchMethod): Javadoc fix.
        * java/util/ArrayList.java (readObject): Javadoc fix.
        (writeObject): Likewise.
        * java/lang/String.java (CaseInsensitiveComparator): Javadoc fix.
        * java/util/zip/PendingBuffer.java (toByteArray): Javadoc fix.
        * javax/swing/plaf/metal/OceanTheme.java: Mark as 1.5.
        * java/util/logging/SimpleFormatter.java (format): Javadoc fix.
        * java/util/zip/ZipFile.java (getEntries): Javadoc fix.

Index: java/io/DataOutputStream.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/DataOutputStream.java,v
retrieving revision 1.20
diff -u -r1.20 DataOutputStream.java
--- java/io/DataOutputStream.java       2 Jul 2005 20:32:37 -0000       1.20
+++ java/io/DataOutputStream.java       13 Sep 2005 21:16:20 -0000
@@ -302,7 +302,7 @@
    *
    * @exception IOException If an error occurs
    *
-   * @see writeInt
+   * @see #writeInt(int)
    * @see DataInput#readFloat
    * @see Float#floatToIntBits
    */
@@ -326,7 +326,7 @@
    *
    * @exception IOException If an error occurs
    *
-   * @see writeLong
+   * @see #writeLong(long)
    * @see DataInput#readDouble
    * @see Double#doubleToLongBits
    */
@@ -363,7 +363,7 @@
    *
    * @exception IOException If an error occurs
    *
-   * @see writeChar
+   * @see #writeChar(char)
    */
   public final void writeChars (String value) throws IOException
   {
Index: java/io/FilterReader.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/FilterReader.java,v
retrieving revision 1.11
diff -u -r1.11 FilterReader.java
--- java/io/FilterReader.java   2 Jul 2005 20:32:37 -0000       1.11
+++ java/io/FilterReader.java   13 Sep 2005 21:16:20 -0000
@@ -131,7 +131,7 @@
   /**
     * Calls the <code>in.skip(long)</code> method
     *
-    * @param numBytes The requested number of chars to skip. 
+    * @param num_chars The requested number of chars to skip. 
     *
     * @return The value returned from <code>in.skip(long)</code>
     *
Index: java/io/InputStreamReader.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/InputStreamReader.java,v
retrieving revision 1.25
diff -u -r1.25 InputStreamReader.java
--- java/io/InputStreamReader.java      2 Jul 2005 20:32:38 -0000       1.25
+++ java/io/InputStreamReader.java      13 Sep 2005 21:16:20 -0000
@@ -38,16 +38,14 @@
 
 package java.io;
 
-import java.nio.charset.UnsupportedCharsetException;
-import java.nio.charset.CharacterCodingException;
-import java.nio.charset.IllegalCharsetNameException;
-import java.nio.charset.CoderResult;
-import java.nio.charset.CodingErrorAction;
+import gnu.java.nio.charset.EncodingHelper;
+
+import java.nio.ByteBuffer;
+import java.nio.CharBuffer;
 import java.nio.charset.Charset;
 import java.nio.charset.CharsetDecoder;
-import java.nio.CharBuffer;
-import java.nio.ByteBuffer;
-import gnu.java.nio.charset.EncodingHelper;
+import java.nio.charset.CoderResult;
+import java.nio.charset.CodingErrorAction;
 
 /**
  * This class reads characters from a byte input stream.   The characters
Index: java/io/LineNumberReader.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/LineNumberReader.java,v
retrieving revision 1.15
diff -u -r1.15 LineNumberReader.java
--- java/io/LineNumberReader.java       2 Jul 2005 20:32:38 -0000       1.15
+++ java/io/LineNumberReader.java       13 Sep 2005 21:16:23 -0000
@@ -115,7 +115,7 @@
   /**
     * This method sets the current line number to the specified value.
     *
-    * @param line_number The new line number
+    * @param lineNumber The new line number
     */
   public void setLineNumber(int lineNumber)
   {
@@ -139,7 +139,7 @@
     * is called, the line number will be restored to the saved line number in
     * addition to the stream position.
     *
-    * @param readlimit The number of chars that can be read before the
+    * @param readLimit The number of chars that can be read before the
     * mark becomes invalid
     *
     * @exception IOException If an error occurs
@@ -269,7 +269,7 @@
     *
     * @param buf The array into which the chars read should be stored
     * @param offset The offset into the array to start storing chars
-    * @param len The requested number of chars to read
+    * @param count The requested number of chars to read
     *
     * @return The actual number of chars read, or -1 if end of stream
     *
Index: java/io/ObjectInputStream.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/ObjectInputStream.java,v
retrieving revision 1.64
diff -u -r1.64 ObjectInputStream.java
--- java/io/ObjectInputStream.java      9 Sep 2005 12:12:03 -0000       1.64
+++ java/io/ObjectInputStream.java      13 Sep 2005 21:16:23 -0000
@@ -1197,7 +1197,7 @@
    * This method should be called by a method called 'readObject' in the
    * deserializing class (if present). It cannot (and should not)be called
    * outside of it. Its goal is to read all fields in the real input stream
-   * and keep them accessible through the address@hidden #GetField} class. 
Calling
+   * and keep them accessible through the address@hidden GetField} class. 
Calling
    * this method will not alter the deserializing object.
    *
    * @return A valid freshly created 'GetField' instance to get access to
Index: java/io/ObjectStreamField.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/ObjectStreamField.java,v
retrieving revision 1.19
diff -u -r1.19 ObjectStreamField.java
--- java/io/ObjectStreamField.java      2 Jul 2005 20:32:38 -0000       1.19
+++ java/io/ObjectStreamField.java      13 Sep 2005 21:16:23 -0000
@@ -208,7 +208,7 @@
    * This method sets the current offset of the field.
    * 
    * @param off The offset of the field in bytes.
-   * @see getOffset()
+   * @see #getOffset()
    */
   protected void setOffset (int off)
   {
Index: java/io/OutputStreamWriter.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/OutputStreamWriter.java,v
retrieving revision 1.17
diff -u -r1.17 OutputStreamWriter.java
--- java/io/OutputStreamWriter.java     2 Jul 2005 20:32:38 -0000       1.17
+++ java/io/OutputStreamWriter.java     13 Sep 2005 21:16:23 -0000
@@ -39,16 +39,14 @@
 package java.io;
 
 import gnu.java.nio.charset.EncodingHelper;
+
 import java.nio.ByteBuffer;
 import java.nio.CharBuffer;
-import java.nio.charset.MalformedInputException;
-import java.nio.charset.UnsupportedCharsetException;
 import java.nio.charset.CharacterCodingException;
-import java.nio.charset.IllegalCharsetNameException;
-import java.nio.charset.CoderResult;
-import java.nio.charset.CodingErrorAction;
 import java.nio.charset.Charset;
 import java.nio.charset.CharsetEncoder;
+import java.nio.charset.CodingErrorAction;
+import java.nio.charset.MalformedInputException;
 
 /**
  * This class writes characters to an output stream that is byte oriented
Index: java/io/PipedInputStream.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/io/PipedInputStream.java,v
retrieving revision 1.19
diff -u -r1.19 PipedInputStream.java
--- java/io/PipedInputStream.java       2 Jul 2005 20:32:38 -0000       1.19
+++ java/io/PipedInputStream.java       13 Sep 2005 21:16:23 -0000
@@ -130,7 +130,7 @@
     * This stream is then ready for reading.  If this stream is already
     * connected or has been previously closed, then an exception is thrown
     *
-    * @param src The <code>PipedOutputStream</code> to connect this stream to
+    * @param source The <code>PipedOutputStream</code> to connect this stream 
to
     *
     * @exception IOException If this PipedInputStream or <code>source</code> 
     *                        has been connected already.
Index: java/lang/Class.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Class.java,v
retrieving revision 1.38
diff -u -r1.38 Class.java
--- java/lang/Class.java        1 Aug 2005 10:05:26 -0000       1.38
+++ java/lang/Class.java        13 Sep 2005 21:16:23 -0000
@@ -41,7 +41,9 @@
 import gnu.classpath.VMStackWalker;
 
 import java.io.InputStream;
+import java.io.ObjectStreamClass;
 import java.io.Serializable;
+import java.lang.reflect.Array;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
@@ -721,7 +723,7 @@
    * @param list List of methods to search
    * @param name Name of method
    * @param args Method parameter types
-   * @see #getMethod()
+   * @see #getMethod(String, Class[])
    */
   private static Method matchMethod(Method[] list, String name, Class[] args)
   {
@@ -829,7 +831,7 @@
    * public and final, but not an interface.
    *
    * @return the modifiers of this class
-   * @see Modifer
+   * @see Modifier
    * @since 1.1
    */
   public int getModifiers()
Index: java/lang/ClassLoader.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/ClassLoader.java,v
retrieving revision 1.56
diff -u -r1.56 ClassLoader.java
--- java/lang/ClassLoader.java  1 Aug 2005 10:23:16 -0000       1.56
+++ java/lang/ClassLoader.java  13 Sep 2005 21:16:23 -0000
@@ -883,7 +883,7 @@
    *
    * @param name the (system specific) name of the requested library
    * @return the full pathname to the requested library, or null
-   * @see Runtime#loadLibrary()
+   * @see Runtime#loadLibrary(String)
    * @since 1.2
    */
   protected String findLibrary(String name)
@@ -913,7 +913,7 @@
    *
    * @param name the package (and subpackages) to affect
    * @param enabled true to set the default to enabled
-   * @see #setDefaultAssertionStatus(String, boolean)
+   * @see #setDefaultAssertionStatus(boolean)
    * @see #setClassAssertionStatus(String, boolean)
    * @see #clearAssertionStatus()
    * @since 1.4
@@ -934,7 +934,7 @@
    * @param name the class to affect
    * @param enabled true to set the default to enabled
    * @throws NullPointerException if name is null
-   * @see #setDefaultAssertionStatus(String, boolean)
+   * @see #setDefaultAssertionStatus(boolean)
    * @see #setPackageAssertionStatus(String, boolean)
    * @see #clearAssertionStatus()
    * @since 1.4
Index: java/lang/Integer.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Integer.java,v
retrieving revision 1.33
diff -u -r1.33 Integer.java
--- java/lang/Integer.java      4 Sep 2005 09:47:13 -0000       1.33
+++ java/lang/Integer.java      13 Sep 2005 21:16:23 -0000
@@ -707,8 +707,8 @@
    * @throws NullPointerException if decode is true and str if null
    * @see #parseInt(String, int)
    * @see #decode(String)
-   * @see Byte#parseInt(String, int)
-   * @see Short#parseInt(String, int)
+   * @see Byte#parseByte(String, int)
+   * @see Short#parseShort(String, int)
    */
   static int parseInt(String str, int radix, boolean decode)
   {
Index: java/lang/Object.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Object.java,v
retrieving revision 1.22
diff -u -r1.22 Object.java
--- java/lang/Object.java       2 Jul 2005 20:32:38 -0000       1.22
+++ java/lang/Object.java       13 Sep 2005 21:16:23 -0000
@@ -343,7 +343,7 @@
    *
    * <p>This thread still holds a lock on the object, so it is
    * typical to release the lock by exiting the synchronized
-   * code, calling wait(), or calling address@hidden Thread#sleep()}, so
+   * code, calling wait(), or calling address@hidden Thread#sleep(long)}, so
    * that the newly awakened thread can actually resume.  The
    * awakened thread will most likely be awakened with an
    * address@hidden InterruptedException}, but that is not guaranteed.
@@ -372,7 +372,7 @@
    *
    * <p>This thread still holds a lock on the object, so it is
    * typical to release the lock by exiting the synchronized
-   * code, calling wait(), or calling address@hidden Thread#sleep()}, so
+   * code, calling wait(), or calling address@hidden Thread#sleep(long)}, so
    * that one of the newly awakened threads can actually resume.
    * The resuming thread will most likely be awakened with an
    * address@hidden InterruptedException}, but that is not guaranteed.
Index: java/lang/Process.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Process.java,v
retrieving revision 1.9
diff -u -r1.9 Process.java
--- java/lang/Process.java      2 Jul 2005 20:32:38 -0000       1.9
+++ java/lang/Process.java      13 Sep 2005 21:16:23 -0000
@@ -39,6 +39,7 @@
 
 package java.lang;
 
+import java.io.File;
 import java.io.InputStream;
 import java.io.OutputStream;
 
Index: java/lang/String.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/String.java,v
retrieving revision 1.68
diff -u -r1.68 String.java
--- java/lang/String.java       12 Jul 2005 08:53:43 -0000      1.68
+++ java/lang/String.java       13 Sep 2005 21:16:23 -0000
@@ -139,7 +139,7 @@
   final int offset;
 
   /**
-   * An implementation for address@hidden CASE_INSENSITIVE_ORDER}.
+   * An implementation for address@hidden #CASE_INSENSITIVE_ORDER}.
    * This must be address@hidden Serializable}. The class name is dictated by
    * compatibility with Sun's JDK.
    */
Index: java/util/ArrayList.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/ArrayList.java,v
retrieving revision 1.28
diff -u -r1.28 ArrayList.java
--- java/util/ArrayList.java    2 Jul 2005 20:32:41 -0000       1.28
+++ java/util/ArrayList.java    13 Sep 2005 21:16:23 -0000
@@ -551,7 +551,7 @@
   /**
    * Serializes this object to the given stream.
    *
-   * @param out the stream to write to
+   * @param s the stream to write to
    * @throws IOException if the underlying stream fails
    * @serialData the size field (int), the length of the backing array
    *             (int), followed by its elements (Objects) in proper order.
@@ -572,7 +572,7 @@
   /**
    * Deserializes this object from the given stream.
    *
-   * @param in the stream to read from
+   * @param s the stream to read from
    * @throws ClassNotFoundException if the underlying stream fails
    * @throws IOException if the underlying stream fails
    * @serialData the size field (int), the length of the backing array
Index: java/util/HashMap.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/HashMap.java,v
retrieving revision 1.30
diff -u -r1.30 HashMap.java
--- java/util/HashMap.java      2 Jul 2005 20:32:42 -0000       1.30
+++ java/util/HashMap.java      13 Sep 2005 21:16:23 -0000
@@ -449,7 +449,7 @@
    *
    * @param value the value to search for in this HashMap
    * @return true if at least one key maps to the value
-   * @see containsKey(Object)
+   * @see #containsKey(Object)
    */
   public boolean containsValue(Object value)
   {
Index: java/util/Locale.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/Locale.java,v
retrieving revision 1.30
diff -u -r1.30 Locale.java
--- java/util/Locale.java       2 Jul 2005 20:32:42 -0000       1.30
+++ java/util/Locale.java       13 Sep 2005 21:16:24 -0000
@@ -915,7 +915,7 @@
   /**
    * Write the locale to an object stream.
    *
-   * @param output the stream to write to
+   * @param s the stream to write to
    * @throws IOException if the write fails
    * @serialData The first three fields are Strings representing language,
    *             country, and variant. The fourth field is a placeholder for 
@@ -935,7 +935,7 @@
   /**
    * Reads a locale from the input stream.
    *
-   * @param input the stream to read from
+   * @param s the stream to read from
    * @throws IOException if reading fails
    * @throws ClassNotFoundException if reading fails
    * @serialData the hashCode is always invalid and must be recomputed
Index: java/util/logging/SimpleFormatter.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/logging/SimpleFormatter.java,v
retrieving revision 1.6
diff -u -r1.6 SimpleFormatter.java
--- java/util/logging/SimpleFormatter.java      2 Jul 2005 20:32:44 -0000       
1.6
+++ java/util/logging/SimpleFormatter.java      13 Sep 2005 21:16:24 -0000
@@ -85,7 +85,7 @@
   /**
    * Formats a log record into a String.
    *
-   * @param the log record to be formatted.
+   * @param record the log record to be formatted.
    *
    * @return a short human-readable message, typically one or two
    *   lines.  Lines are separated using the default platform line
Index: java/util/zip/PendingBuffer.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/zip/PendingBuffer.java,v
retrieving revision 1.4
diff -u -r1.4 PendingBuffer.java
--- java/util/zip/PendingBuffer.java    2 Jul 2005 20:32:44 -0000       1.4
+++ java/util/zip/PendingBuffer.java    13 Sep 2005 21:16:24 -0000
@@ -183,7 +183,7 @@
   /**
    * Flushes the pending buffer and returns that data in a new array
    * 
-   * @param output the output stream
+   * @return the output stream
    */
 
   public final byte[] toByteArray()
Index: java/util/zip/ZipFile.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/util/zip/ZipFile.java,v
retrieving revision 1.24
diff -u -r1.24 ZipFile.java
--- java/util/zip/ZipFile.java  30 Aug 2005 21:47:44 -0000      1.24
+++ java/util/zip/ZipFile.java  13 Sep 2005 21:16:24 -0000
@@ -377,7 +377,7 @@
    * Checks that the ZipFile is still open and reads entries when necessary.
    *
    * @exception IllegalStateException when the ZipFile has already been closed.
-   * @exception IOEexception when the entries could not be read.
+   * @exception IOException when the entries could not be read.
    */
   private HashMap getEntries() throws IOException
   {
Index: javax/swing/plaf/metal/OceanTheme.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/plaf/metal/OceanTheme.java,v
retrieving revision 1.1
diff -u -r1.1 OceanTheme.java
--- javax/swing/plaf/metal/OceanTheme.java      8 Sep 2005 15:26:22 -0000       
1.1
+++ javax/swing/plaf/metal/OceanTheme.java      13 Sep 2005 21:16:24 -0000
@@ -41,6 +41,7 @@
 
 /**
  * A modern theme for the Metal Look &amp; Feel.
+ * @since 1.5
  *
  * @author Roman Kennke (address@hidden)
  */