/*
 * Copyright 2016 requery.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.requery;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Indicates a field as being an indexed column in a database table.
 */
@Documented
@Target({FIELD, METHOD})
@Retention(RUNTIME)
public @interface Index {

    /**
     * @return name of the index.
     */
    String name() default "";
}

@@ -968,16 +968,228 @@
  table.%0A
+ *%0A * Example:%0A * %3Cpre%3E%3Ccode%3E%0A *    %7B@literal @%7DEntity%0A *     public class AbstractPerson %7B%0A *         ...%0A *        %7B@literal @%7DIndex(name = %22email_index%22) String email;%0A *         ...%0A *     %7D%0A * %3C/code%3E%3C/pre%3E%0A
  */%0A@Doc

Update documentation