1 package org.hyphenType.documentation;
2
3 import java.lang.annotation.ElementType;
4 import java.lang.annotation.Retention;
5 import java.lang.annotation.RetentionPolicy;
6 import java.lang.annotation.Target;
7
8 import org.hyphenType.documentation.rbgenerator.RBGenerator;
9
10 /**
11 * Documents a property of a formatter annotation for
12 * <strong>developers</strong>. This
13 * annotation is used by the {@link RBGenerator} to create
14 * comments before each formatter option property in the
15 * generated resource bundle. Also, this annotation can
16 * be used to document a documentation formatter in a
17 * machine readable way.
18 *
19 * @author akira
20 */
21 @Retention(RetentionPolicy.RUNTIME)
22 @Target({ElementType.METHOD, ElementType.FIELD})
23 public @interface Description {
24 String value();
25 }