src/javax/persistence/Index.java

@@ -1,4 +1,4 @@
-/*******************************************************************************
+/** *****************************************************************************
  * Copyright (c) 2011 - 2013 Oracle Corporation. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -11,7 +11,7 @@
  * Contributors:
  *     Linda DeMichiel - Java Persistence 2.1
  *
- ******************************************************************************/
+ ***************************************************************************** */
 package javax.persistence;
 
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
@@ -24,23 +24,18 @@ import java.lang.annotation.Target;
  * Note that it is not necessary to specify an index for a primary key,
  * as the primary key index will be created automatically.
  *
- * <p> 
- * The syntax of the <code>columnList</code> element is a 
+ * <p>
+ * The syntax of the <code>columnList</code> element is a
  * <code>column_list</code>, as follows:
- * 
+ *
  * <pre>
  *    column::= index_column [,index_column]*
  *    index_column::= column_name [ASC | DESC]
  * </pre>
- * 
- * <p> If <code>ASC</code> or <code>DESC</code> is not specified, 
- * <code>ASC</code> (ascending order) is assumed.
  *
- * @see Table
- * @see SecondaryTable
- * @see CollectionTable
- * @see JoinTable
- * @see TableGenerator
+ * <p>
+ * If <code>ASC</code> or <code>DESC</code> is not specified,
+ * <code>ASC</code> (ascending order) is assumed.
  *
  * @since Java Persistence 2.1
  *
@@ -51,17 +46,23 @@ public @interface Index {
 
     /**
      * (Optional) The name of the index; defaults to a provider-generated name.
+     *
+     * @return String
      */
     String name() default "";
 
     /**
-     * (Required) The names of the columns to be included in the index, 
+     * (Required) The names of the columns to be included in the index,
      * in order.
+     *
+     * @return String
      */
     String columnList();
 
     /**
      * (Optional) Whether the index is unique.
+     *
+     * @return boolean
      */
     boolean unique() default false;