1 /** */ 2 package org.unicode.cldr.util; 3 4 import java.lang.annotation.ElementType; 5 import java.lang.annotation.Retention; 6 import java.lang.annotation.RetentionPolicy; 7 import java.lang.annotation.Target; 8 9 /** 10 * This annotation is used to mark CLDR Tools that are runnable by users. All CLDR Tools should be 11 * so annotated. Running "java -jar cldr-code.jar" will list all annotated tools. See: 12 * http://cldr.unicode.org/development/coding-cldr-tools/documenting-cldr-tools 13 * 14 * @author srl 15 */ 16 @Target({ElementType.TYPE}) 17 @Retention(RetentionPolicy.RUNTIME) 18 public @interface CLDRTool { 19 20 /** 21 * Short name for this tool. Required. 22 * 23 * @return 24 */ alias()25 String alias(); 26 27 /** 28 * Long description of the purpose of this tool. 29 * 30 * @return 31 */ description()32 String description() default ""; 33 34 /** 35 * If non-empty, a description of why this tool should be hidden from user view. Example: 36 * hidden="BROKEN" or hidden="one-off testing tool" or hidden="" for visible 37 * 38 * @return 39 */ hidden()40 String hidden() default ""; 41 42 /** If non-empty, URL to further docs on this tool. */ url()43 String url() default ""; 44 } 45