[cp-patches] [generics] Patch: FYI: some attribute documentation

[Tom Tromey]

This documents Override and Deprecated.

Tom

 2004-09-04  Tom Tromey  <address@hidden>
 
        * java/lang/Override.java: Documented.
        * java/lang/Deprecated.java: Documented.

Index: java/lang/Override.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Attic/Override.java,v
retrieving revision 1.1.2.3
diff -u -r1.1.2.3 Override.java
--- java/lang/Override.java     5 Sep 2004 00:53:04 -0000       1.1.2.3
+++ java/lang/Override.java     8 Sep 2004 00:42:45 -0000
@@ -42,6 +42,14 @@
 import static java.lang.annotation.RetentionPolicy.SOURCE;
 import static java.lang.annotation.ElementType.METHOD;
 
+/**
+ * This annotation is used as a marker to indicate that the annotated
+ * method declaration is intended to override another method in the
+ * class hierarchy.  If this is not the case, the compiler will emit a
+ * warning.
+ *
+ * @since 1.5
+ */
 @Retention(SOURCE) @Target(METHOD)
 public @interface Override
 {
Index: java/lang/Deprecated.java
===================================================================
RCS file: /cvsroot/classpath/classpath/java/lang/Attic/Deprecated.java,v
retrieving revision 1.1.2.3
diff -u -r1.1.2.3 Deprecated.java
--- java/lang/Deprecated.java   5 Sep 2004 00:53:04 -0000       1.1.2.3
+++ java/lang/Deprecated.java   8 Sep 2004 00:42:45 -0000
@@ -41,6 +41,13 @@
 import java.lang.annotation.Retention;
 import static java.lang.annotation.RetentionPolicy.SOURCE;
 
+/**
+ * This annotation is used as a marker to indicate that the annotated
+ * declaration is deprecated and should not be used in new code.
+ * This replaces the old "@deprecated" javadoc tag.
+ *
+ * @since 1.5
+ */
 @Documented @Retention(SOURCE)
 public @interface Deprecated
 {