Feather2 / feather2-runtime / src / main / java / uk / co / nickthecoder / feather / runtime / Documentation.java

package uk.co.nickthecoder.feather.runtime;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * text() returns the documentation comments for the class/constructor/field or method.
 * Leading white space and asterisks are removed.
 * No other formatting is performed.
 *
 * <p>
 * This annotation is only present when FeatherConfiguration.includeMetaData == true.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD})
public @interface Documentation {
    String text() default "";
}