[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Small javadoc patch for classpath.
From: |
C. Scott Ananian |
Subject: |
Small javadoc patch for classpath. |
Date: |
Sat, 13 Jul 2002 01:12:30 -0400 (EDT) |
I checked out & played with gjdoc a bit tonight, and generated javadoc
HTML for classpath to test things out. As I was leafing through the
generated javadoc, I noticed a few typos and violations of the "first
sentence should be a summary" rule for javadoc comments. Attached is
a short & simple patch for the things I found and fixed; hope y'all
find it useful.
--scott
corporate globalization India SSBN 743 Saddam Hussein PLO supercomputer
MI5 Treasury Mossad Attache radar hack NORAD Sugar Grove jihad Ortega
( http://cscott.net/ )
Index: java/lang/AssertionError.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/AssertionError.java,v
retrieving revision 1.2
diff -u -p -r1.2 AssertionError.java
--- java/lang/AssertionError.java 24 Feb 2002 04:25:16 -0000 1.2
+++ java/lang/AssertionError.java 13 Jul 2002 05:09:07 -0000
@@ -42,7 +42,7 @@ package java.lang;
* An assertion error normally occurs as a result of the <code>assert</code>
* statement added in JDK 1.4, to indicate that an assertion failed. There
* are enough constructors to ensure that
- * <code>new AssertionError(<em>expression</em)</code> will work for all
+ * <code>new AssertionError(<em>expression</em>)</code> will work for all
* espressions, regardless of type, as if the error message were given by
* the string <code>"" + <em>expression</em></code>. This extends Error,
* because you usually do not want to inadvertently trap an assertion failure.
Index: java/net/Authenticator.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/net/Authenticator.java,v
retrieving revision 1.7
diff -u -p -r1.7 Authenticator.java
--- java/net/Authenticator.java 22 Jan 2002 22:27:00 -0000 1.7
+++ java/net/Authenticator.java 13 Jul 2002 05:09:07 -0000
@@ -38,10 +38,10 @@ exception statement from your version. *
package java.net;
/**
- * Sometimes a network operation (such as hitting a password protected
- * web site) will require authentication information in the form of a
- * username and password. This abstract class provides a model for
- * obtaining that information.
+ * This abstract class provides a model for obtaining authentication
+ * information (in the form of a username and password) required by
+ * some network operations (such as hitting a password protected
+ * web site).
* <p>
* To make use of this feature, a programmer must create a subclass of
* Authenticator that knows how to obtain the necessary info. An example
Index: java/net/DatagramSocketImpl.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/net/DatagramSocketImpl.java,v
retrieving revision 1.13
diff -u -p -r1.13 DatagramSocketImpl.java
--- java/net/DatagramSocketImpl.java 9 Feb 2002 23:34:44 -0000 1.13
+++ java/net/DatagramSocketImpl.java 13 Jul 2002 05:09:07 -0000
@@ -42,13 +42,14 @@ import java.io.IOException;
import java.io.FileDescriptor;
/**
+ * This abstract class models a datagram socket implementation. An
+ * actual implementation class would implement these methods, probably
+ * via redirecting them to native code.
+ * <p>
* Written using on-line Java Platform 1.2 API Specification, as well
* as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
+ * <p>
* Status: Believed complete and correct.
- *
- * <p>This abstract class models a datagram socket implementation. An
- * actual implementation class would implement these methods, probably
- * via redirecting them to native code.
*
* @author Aaron M. Renn (address@hidden)
* @author Warren Levy <address@hidden>
Index: java/net/SocketAddress.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/net/SocketAddress.java,v
retrieving revision 1.2
diff -u -p -r1.2 SocketAddress.java
--- java/net/SocketAddress.java 30 Apr 2002 21:37:26 -0000 1.2
+++ java/net/SocketAddress.java 13 Jul 2002 05:09:07 -0000
@@ -40,9 +40,9 @@ package java.net;
import java.io.*;
/**
- * Ronald: abstract base class for InetSocketAddress.
+ * Abstract base class for InetSocketAddress.
* InetSocketAddress is to my knowledge the only derived
- * class.
+ * class. [Ronald]
*/
public abstract class SocketAddress implements Serializable