[cp-patches] [generics] Patch: FYI: minor documentation improvements

[Tom Tromey]

I'm checking this in on the generics branch.
This is a tiny documentation improvement.

Tom

Index: ChangeLog
from  Tom Tromey  <address@hidden>

        * java/lang/annotation/Retention.java: Documented.
        * java/lang/annotation/RetentionPolicy.java: Documented.
        * java/lang/StringBuilder.java: Updated documentation.

Index: java/lang/StringBuilder.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Attic/StringBuilder.java,v
retrieving revision 1.1.2.1
diff -u -r1.1.2.1 StringBuilder.java
--- java/lang/StringBuilder.java 8 Sep 2004 00:45:41 -0000 1.1.2.1
+++ java/lang/StringBuilder.java 18 Sep 2004 22:51:43 -0000
@@ -62,16 +62,17 @@
  *
  * <p>Classpath's StringBuilder is capable of sharing memory with Strings for
  * efficiency.  This will help when a StringBuilder is converted to a String
- * and the StringBuilder is not changed after that (quite common when 
performing
- * string concatenation).
+ * and the StringBuilder is not changed after that (quite common when
+ * performing string concatenation).
  *
  * @author Paul Fisher
  * @author John Keiser
  * @author Tom Tromey
  * @author Eric Blake <address@hidden>
  * @see String
- * @since 1.0
- * @status updated to 1.4
+ * @see StringBuffer
+ *
+ * @since 1.5
  */
 public final class StringBuilder
   implements Serializable, CharSequence, Appendable
Index: java/lang/annotation/Retention.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/java/lang/annotation/Attic/Retention.java,v
retrieving revision 1.1.2.1
diff -u -r1.1.2.1 Retention.java
--- java/lang/annotation/Retention.java 7 Aug 2004 19:01:27 -0000 1.1.2.1
+++ java/lang/annotation/Retention.java 18 Sep 2004 22:51:43 -0000
@@ -38,10 +38,17 @@
 package java.lang.annotation;
 
 /**
+ * This annotation is used to specify the desired lifetime of another
+ * annotation.
+ *
+ * @see RetentionPolicy
  * @since 1.5
  */
 @Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE)
 public @interface Retention
 {
+  /**
+   * The value holds the lifetime of the annotation.
+   */
   RetentionPolicy value();
 }
Index: java/lang/annotation/RetentionPolicy.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/java/lang/annotation/Attic/RetentionPolicy.java,v
retrieving revision 1.1.2.1
diff -u -r1.1.2.1 RetentionPolicy.java
--- java/lang/annotation/RetentionPolicy.java 7 Aug 2004 19:01:27 -0000 1.1.2.1
+++ java/lang/annotation/RetentionPolicy.java 18 Sep 2004 22:51:43 -0000
@@ -38,11 +38,23 @@
 package java.lang.annotation;
 
 /**
+ * This enum is used to control the lifetime of an annotation.
+ *
+ * @see Retention
+ *
  * @since 1.5
  */
 public enum RetentionPolicy
 {
+  /** Indicates that the annotation should be stored in class files.  */
   CLASS,
+
+  /** Indicates that the annotation should be available at runtime.  */
   RUNTIME,
+
+  /**
+   * Indicates that the annotation should only be available when
+   * parsing the source code.
+   */
   SOURCE
 }