diff --git a/src/main/java/com/samskivert/depot/annotation/Index.java b/src/main/java/com/samskivert/depot/annotation/Index.java index cea59fc..8acc35f 100644 --- a/src/main/java/com/samskivert/depot/annotation/Index.java +++ b/src/main/java/com/samskivert/depot/annotation/Index.java @@ -17,20 +17,20 @@ import java.lang.annotation.Target; public @interface Index { /** - * Defines the name of the index.

+ * Defines the name of the index. * - * If this annotation is on a field, an index is created for all fields annotated with this - * name in the order of the fields in the class.

+ *

If this annotation is on a field, an index is created for all fields annotated with this + * name in the order of the fields in the class.

* - * If this is defined, a static method must be defined on the record that provides the index - * configuration. The method must match one of the following two signatures: + *

If this annotation is on a {@code PersistentRecord} class, a static method must be + * defined in that class that provides the index configuration. The method must match one of + * the following two signatures: *

      * public static ColumnExp[] indexName ()
      * public static List<Tuple<SQLExpression, OrderBy.Order>> indexName ()
      * 
- * The first form will result in a simple multicolum index being created - * with the supplied columns. The second will create a function index using the supplied - * SQLExpressions. + * The first form will result in a simple multicolum index being created with the supplied + * columns. The second will create a function index using the supplied {@code SQLExpression}s.

*/ String name () default "";