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