Commit 0e2e89fd by Anthony Green Committed by Anthony Green

Fix comments for doclets

From-SVN: r38754
parent a7c52352
2001-01-06 Anthony Green <green@redhat.com>
* java/beans/PropertyDescriptor.java: Fix comment.
* java/io/PushbackReader.java: Fix comment.
* java/io/ObjectStreamClass.java: Fix comment.
* java/io/DataInputStream.java: Fix comment.
* java/io/PipedInputStream.java: Fix comments.
* java/io/PipedReader.java: Fix comments.
* java/sql/DatabaseMetaData.java: Fix comments.
2001-01-06 Bryce McKinlay <bryce@albatross.co.nz> 2001-01-06 Bryce McKinlay <bryce@albatross.co.nz>
* java/io/PipedReader: Synchronize on "lock" instead of this. * java/io/PipedReader: Synchronize on "lock" instead of this.
......
/* java.beans.PropertyDescriptor /* java.beans.PropertyDescriptor
Copyright (C) 1998 Free Software Foundation, Inc. Copyright (C) 1998, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
...@@ -208,7 +208,7 @@ public class PropertyDescriptor extends FeatureDescriptor { ...@@ -208,7 +208,7 @@ public class PropertyDescriptor extends FeatureDescriptor {
** will be undefined.<P> ** will be undefined.<P>
** **
** When a property is bound, its set method is required to fire the ** When a property is bound, its set method is required to fire the
** <CODE>PropertyChangeListener.propertyChange())</CODE event ** <CODE>PropertyChangeListener.propertyChange())</CODE> event
** after the value has changed. ** after the value has changed.
** @param bound whether the property is bound or not. ** @param bound whether the property is bound or not.
**/ **/
......
/* Copyright (C) 1998, 1999, 2000 Free Software Foundation /* Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation
This file is part of libgcj. This file is part of libgcj.
...@@ -534,7 +534,7 @@ public class DataInputStream extends FilterInputStream implements DataInput ...@@ -534,7 +534,7 @@ public class DataInputStream extends FilterInputStream implements DataInput
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> and code{byte2</code> * As an example, if <code>byte1</code> and <code>byte2</code>
* represent the first and second byte read from the stream * represent the first and second byte read from the stream
* respectively, they will be transformed to an <code>int</code> in * respectively, they will be transformed to an <code>int</code> in
* the following manner: * the following manner:
......
/* ObjectStreamClass.java -- Class used to write class information /* ObjectStreamClass.java -- Class used to write class information
about serialized objects. about serialized objects.
Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc. Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
...@@ -186,7 +186,7 @@ public class ObjectStreamClass implements Serializable ...@@ -186,7 +186,7 @@ public class ObjectStreamClass implements Serializable
// Returns the <code>ObjectStreamClass</code> that represents the // Returns the <code>ObjectStreamClass</code> that represents the
// class that is the superclass of the class this // class that is the superclass of the class this
// <code>ObjectStreamClass</cdoe> represents. If the superclass is // <code>ObjectStreamClass</code> represents. If the superclass is
// not Serializable, null is returned. // not Serializable, null is returned.
ObjectStreamClass getSuper () ObjectStreamClass getSuper ()
{ {
......
...@@ -209,7 +209,7 @@ public class PipedInputStream extends InputStream ...@@ -209,7 +209,7 @@ public class PipedInputStream extends InputStream
/** /**
* This method reads bytes from the stream into a caller supplied buffer. * This method reads bytes from the stream into a caller supplied buffer.
* It starts storing bytes at position <code>offset</code> into the buffer and * It starts storing bytes at position <code>offset</code> into the buffer and
* reads a maximum of <cod>>len</code> bytes. Note that this method can actually * reads a maximum of <code>len</code> bytes. Note that this method can actually
* read fewer than <code>len</code> bytes. The actual number of bytes read is * read fewer than <code>len</code> bytes. The actual number of bytes read is
* returned. A -1 is returned to indicated that no bytes can be read * returned. A -1 is returned to indicated that no bytes can be read
* because the end of the stream was reached. If the stream is already * because the end of the stream was reached. If the stream is already
...@@ -240,7 +240,7 @@ public class PipedInputStream extends InputStream ...@@ -240,7 +240,7 @@ public class PipedInputStream extends InputStream
/** /**
* This method reads bytes from the stream into a caller supplied buffer. * This method reads bytes from the stream into a caller supplied buffer.
* It starts storing bytes at position <code>offset</code> into the buffer and * It starts storing bytes at position <code>offset</code> into the buffer and
* reads a maximum of <cod>>len</code> bytes. Note that this method can actually * reads a maximum of <code>len</code> bytes. Note that this method can actually
* read fewer than <code>len</code> bytes. The actual number of bytes read is * read fewer than <code>len</code> bytes. The actual number of bytes read is
* returned. A -1 is returned to indicated that no bytes can be read * returned. A -1 is returned to indicated that no bytes can be read
* because the end of the stream was reached - ie close() was called on the * because the end of the stream was reached - ie close() was called on the
......
...@@ -197,7 +197,7 @@ public class PipedReader extends Reader ...@@ -197,7 +197,7 @@ public class PipedReader extends Reader
/** /**
* This method reads chars from the stream into a caller supplied buffer. * This method reads chars from the stream into a caller supplied buffer.
* It starts storing chars at position <code>offset</code> into the buffer and * It starts storing chars at position <code>offset</code> into the buffer and
* reads a maximum of <cod>>len</code> chars. Note that this method can actually * reads a maximum of <code>len</code> chars. Note that this method can actually
* read fewer than <code>len</code> chars. The actual number of chars read is * read fewer than <code>len</code> chars. The actual number of chars read is
* returned. A -1 is returned to indicated that no chars can be read * returned. A -1 is returned to indicated that no chars can be read
* because the end of the stream was reached. If the stream is already * because the end of the stream was reached. If the stream is already
...@@ -228,7 +228,7 @@ public class PipedReader extends Reader ...@@ -228,7 +228,7 @@ public class PipedReader extends Reader
/** /**
* This method reads characters from the stream into a caller supplied buffer. * This method reads characters from the stream into a caller supplied buffer.
* It starts storing chars at position <code>offset</code> into the buffer and * It starts storing chars at position <code>offset</code> into the buffer and
* reads a maximum of <cod>>len</code> chars. Note that this method can actually * reads a maximum of <code>len</code> chars. Note that this method can actually
* read fewer than <code>len</code> chars. The actual number of chars read is * read fewer than <code>len</code> chars. The actual number of chars read is
* returned. A -1 is returned to indicated that no chars can be read * returned. A -1 is returned to indicated that no chars can be read
* because the end of the stream was reached - ie close() was called on the * because the end of the stream was reached - ie close() was called on the
......
/* PushbackReader.java -- An character stream that can unread chars /* PushbackReader.java -- An character stream that can unread chars
Copyright (C) 1998, 2000 Free Software Foundation, Inc. Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
...@@ -391,7 +391,7 @@ unread(char[] buf) throws IOException ...@@ -391,7 +391,7 @@ unread(char[] buf) throws IOException
/** /**
* This method pushed back chars from the passed in array into the pushback * This method pushed back chars from the passed in array into the pushback
* buffer. The chars from <code>buf[offset]</code> to <cdoe>buf[offset + len]</code> * buffer. The chars from <code>buf[offset]</code> to <code>buf[offset + len]</code>
* are pushed in reverse order so that the next char read from the stream * are pushed in reverse order so that the next char read from the stream
* after this operation will be <code>buf[offset]</code> followed by * after this operation will be <code>buf[offset]</code> followed by
* <code>buf[offset + 1]</code>, etc. * <code>buf[offset + 1]</code>, etc.
......
/* DatabaseMetaData.java -- Information about the database itself. /* DatabaseMetaData.java -- Information about the database itself.
Copyright (C) 1999, 2000 Free Software Foundation, Inc. Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
...@@ -2109,7 +2109,7 @@ getTablePrivileges(String catalog, String schema, String table) ...@@ -2109,7 +2109,7 @@ getTablePrivileges(String catalog, String schema, String table)
* <ol> * <ol>
* <li>SCOPE - The scope of the results returned. This is one of the * <li>SCOPE - The scope of the results returned. This is one of the
* constants defined in this class (<code>bestRowTemporary</code>, * constants defined in this class (<code>bestRowTemporary</code>,
* <code>bestRowTransaction</code>, or <code>bestRowSession</code). * <code>bestRowTransaction</code>, or <code>bestRowSession</code>).
* <li>COLUMN_NAME - The name of the column. * <li>COLUMN_NAME - The name of the column.
* <li>DATA_TYPE - The SQL type of the column. This is one of the constants * <li>DATA_TYPE - The SQL type of the column. This is one of the constants
* defined in <code>Types</code>. * defined in <code>Types</code>.
...@@ -2193,6 +2193,7 @@ getVersionColumns(String catalog, String schema, String table) ...@@ -2193,6 +2193,7 @@ getVersionColumns(String catalog, String schema, String table)
* <li>COLUMN_NAME - The name of the column. * <li>COLUMN_NAME - The name of the column.
* <li>KEY_SEQ - The sequence number of the column within the primary key. * <li>KEY_SEQ - The sequence number of the column within the primary key.
* <li>PK_NAME - The name of the primary key, which may be <code>null</code>. * <li>PK_NAME - The name of the primary key, which may be <code>null</code>.
* </ol>
* *
* @param catalog The catalog to retrieve information from, or the empty string * @param catalog The catalog to retrieve information from, or the empty string
* to return entities not associated with a catalog, or <code>null</code> * to return entities not associated with a catalog, or <code>null</code>
...@@ -2241,6 +2242,7 @@ getPrimaryKeys(String catalog, String schema, String table) ...@@ -2241,6 +2242,7 @@ getPrimaryKeys(String catalog, String schema, String table)
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>, * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or * <code>importedKeyInitiallyImmediate</code>, or
* <code>importedKeyNotDeferrable</code>). * <code>importedKeyNotDeferrable</code>).
* </ol>
* *
* @param catalog The catalog to retrieve information from, or the empty string * @param catalog The catalog to retrieve information from, or the empty string
* to return entities not associated with a catalog, or <code>null</code> * to return entities not associated with a catalog, or <code>null</code>
...@@ -2289,6 +2291,7 @@ getImportedKeys(String catalog, String schema, String table) ...@@ -2289,6 +2291,7 @@ getImportedKeys(String catalog, String schema, String table)
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>, * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or * <code>importedKeyInitiallyImmediate</code>, or
* <code>importedKeyNotDeferrable</code>). * <code>importedKeyNotDeferrable</code>).
* </ol>
* *
* @param catalog The catalog to retrieve information from, or the empty string * @param catalog The catalog to retrieve information from, or the empty string
* to return entities not associated with a catalog, or <code>null</code> * to return entities not associated with a catalog, or <code>null</code>
...@@ -2337,6 +2340,7 @@ getExportedKeys(String catalog, String schema, String table) ...@@ -2337,6 +2340,7 @@ getExportedKeys(String catalog, String schema, String table)
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>, * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or * <code>importedKeyInitiallyImmediate</code>, or
* <code>importedKeyNotDeferrable</code>). * <code>importedKeyNotDeferrable</code>).
* </ol>
* *
* @param primCatalog The catalog to retrieve information from, or the empty string * @param primCatalog The catalog to retrieve information from, or the empty string
* to return entities not associated with a catalog, or <code>null</code> * to return entities not associated with a catalog, or <code>null</code>
...@@ -2436,6 +2440,7 @@ getTypeInfo() throws SQLException; ...@@ -2436,6 +2440,7 @@ getTypeInfo() throws SQLException;
* in the table if the index type is <code>tableIndexStatistic</code>. * in the table if the index type is <code>tableIndexStatistic</code>.
* <li>FILTER_CONDITION - The filter condition for this index, which may be * <li>FILTER_CONDITION - The filter condition for this index, which may be
* <code>null</code>. * <code>null</code>.
* </ol>
* *
* @param catalog The catalog to retrieve information from, or the empty string * @param catalog The catalog to retrieve information from, or the empty string
* to return entities not associated with a catalog, or <code>null</code> * to return entities not associated with a catalog, or <code>null</code>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment