Improve the documentation here.

This commit is contained in:
Michael Bayne
2011-11-23 03:06:14 +00:00
parent 33615067d9
commit fb0a5f2884
@@ -17,20 +17,20 @@ import java.lang.annotation.Target;
public @interface Index public @interface Index
{ {
/** /**
* Defines the name of the index.<p> * Defines the name of the index.
* *
* If this annotation is on a field, an index is created for all fields annotated with this * <p>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.<p> * name in the order of the fields in the class.</p>
* *
* If this is defined, a static method must be defined on the record that provides the index * <p>If this annotation is on a {@code PersistentRecord} class, a static method must be
* configuration. The method must match one of the following two signatures: * defined in that class that provides the index configuration. The method must match one of
* the following two signatures:
* <pre> * <pre>
* public static ColumnExp<?>[] indexName () * public static ColumnExp<?>[] indexName ()
* public static List&lt;Tuple&lt;SQLExpression, OrderBy.Order>> indexName () * public static List&lt;Tuple&lt;SQLExpression, OrderBy.Order>> indexName ()
* </pre> * </pre>
* The first form will result in a simple multicolum index being created * The first form will result in a simple multicolum index being created with the supplied
* with the supplied columns. The second will create a function index using the supplied * columns. The second will create a function index using the supplied {@code SQLExpression}s.</p>
* SQLExpressions.
*/ */
String name () default ""; String name () default "";