View Javadoc
1 package attrib4j; 2 3 import java.util.Arrays; 4 import java.util.HashSet; 5 import java.util.Set; 6 7 /*** 8 * @author Mark.Pollack 9 */ 10 public class Utensil { 11 12 /*** 13 * The set of all javadoc tags that can appear in the documentation 14 * for a class/interface 15 */ 16 private static Set _classTags = new HashSet(); 17 18 /*** 19 * The set of all javadoc tags that can appear in the documentation 20 * for a method. 21 */ 22 private static Set _methodTags = new HashSet(); 23 24 /*** 25 * The set of all javadoc tags that can appear in the documentation 26 * for a field. 27 */ 28 private static Set _fieldTags = new HashSet(); 29 30 static { 31 _classTags = new HashSet(); 32 String cTags[] = 33 { 34 "@attribute", 35 "@see", 36 "@since", 37 "@deprecated", 38 "@serial", 39 "@author", 40 "@version", 41 "{@link}", 42 "{@linkplain}", 43 "{@docRoot}" }; 44 45 _classTags.addAll(Arrays.asList(cTags)); 46 47 _methodTags = new HashSet(); 48 String mTags[] = 49 { 50 "@attribute", 51 "@see", 52 "@since", 53 "@deprecated", 54 "@param", 55 "@return", 56 "@throws", 57 "@exception", 58 "@serialData", 59 "{@link}", 60 "{@linkplain}", 61 "{@inheritDoc}", 62 "{@docRoot}" }; 63 64 _methodTags.addAll(Arrays.asList(mTags)); 65 66 _fieldTags = new HashSet(); 67 String fTags[] = 68 { 69 "@attribute", 70 "@see", 71 "@since", 72 "@deprecated", 73 "@serial", 74 "@serialField", 75 "{@link}", 76 "{@linkplain}", 77 "{@docRoot}", 78 "{@value}" }; 79 80 _fieldTags.addAll(Arrays.asList(fTags)); 81 } 82 83 84 /*** 85 * Return the set of all javadoc tags used for documentation 86 * of classes/interfaces 87 * @return Set The set of all javadoc tags used for documentation. 88 * of classes/interfaces 89 */ 90 public static Set getJavadocClassTags() { 91 return _classTags; 92 } 93 94 /*** 95 * Return the set of all javadoc tags used for documentation 96 * of methods. 97 * @return Set The set of all javadoc tags used for documentation 98 * of methods 99 */ 100 public static Set getJavadocMethodTags() { 101 return _methodTags; 102 } 103 104 /*** 105 * Return the set of all javadoc tags used for documentation 106 * of fields 107 * @return Set The set of all javadoc tags used for documentation 108 * of fields 109 */ 110 public static Set getJavadocFieldTags() { 111 return _fieldTags; 112 } 113 114 }

This page was automatically generated by Maven