< prev index next >

jaxws/src/java.xml.ws.annotation/share/classes/javax/annotation/Generated.java

Print this page

        

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -27,36 +27,40 @@
 import java.lang.annotation.*;
 import static java.lang.annotation.ElementType.*;
 import static java.lang.annotation.RetentionPolicy.*;
 
 /**
- * The Generated annotation is used to mark source code that has been generated.
+ * The <code>Generated</code> annotation is used to mark source code
+ * that has been generated.
  * It can also be used to differentiate user written code from generated code
- * in a single file. When used, the value element must have the name of the
+ * in a single file.
+ * <p>The <code>value</code> element must have the name of the
  * code generator. The recommended convention is to use the fully qualified
- * name of the code generator in the value field .
- * <p>For example: com.company.package.classname.
- * The date element is used to indicate the date the source was generated.
- * The date element must follow the ISO 8601 standard. For example the date
- * element would have the following value 2001-07-04T12:08:56.235-0700
+ * name of the code generator in the value field,
+ * for example <code>com.company.package.classname</code>.</p>
+ * <p>The <code>date</code> element is used to indicate the date the
+ * source was generated.
+ * The <code>date</code> element must follow the ISO 8601 standard.
+ * For example, the <code>date</code> element could have the
+ * value <code>2001-07-04T12:08:56.235-0700</code>,
  * which represents 2001-07-04 12:08:56 local time in the U.S. Pacific
- * Time time zone.</p>
- * <p>The comment element is a place holder for any comments that the code
- * generator may want to include in the generated code.</p>
+ * time zone.</p>
+ * <p>The <code>comment</code> element is a place holder for any comments
+ * that the code generator may want to include in the generated code.</p>
  *
  * @since 1.6, Common Annotations 1.0
  */
 
 @Documented
 @Retention(SOURCE)
 @Target({PACKAGE, TYPE, ANNOTATION_TYPE, METHOD, CONSTRUCTOR, FIELD,
         LOCAL_VARIABLE, PARAMETER})
 public @interface Generated {
    /**
-    * The value element MUST have the name of the code generator.
+    * The value element must have the name of the code generator.
     * The recommended convention is to use the fully qualified name of the
-    * code generator. For example: com.acme.generator.CodeGen.
+    * code generator. For example: <code>com.acme.generator.CodeGen</code>.
     */
    String[] value();
 
    /**
     * Date when the source was generated.
< prev index next >