org.incava.doctorj

Class JavadocTags

public class JavadocTags extends Object

Javadoc tags and the order in which they should appear for each Java type.
Nested Class Summary
static classJavadocTags.TagDescription
Field Summary
static StringAUTHOR
static intCUSTOM_TAG
static StringDEPRECATED
static StringEXCEPTION
static StringPARAM
static StringRETURN
static StringSEE
static StringSERIAL
static StringSERIALDATA
static StringSERIALFIELD
static StringSINCE
static StringTHROWS
static StringVERSION
Method Summary
static voidadd(JavadocTags.TagDescription td)
static intgetIndex(String tag)
static ListgetTagsAtIndex(int index)
static ListgetValidClassTags()
static ListgetValidConstructorTags()
static ListgetValidFieldTags()
static ListgetValidInterfaceTags()
static ListgetValidMethodTags()

Field Detail

AUTHOR

public static final String AUTHOR

CUSTOM_TAG

public static final int CUSTOM_TAG

DEPRECATED

public static final String DEPRECATED

EXCEPTION

public static final String EXCEPTION

PARAM

public static final String PARAM

RETURN

public static final String RETURN

SEE

public static final String SEE

SERIAL

public static final String SERIAL

SERIALDATA

public static final String SERIALDATA

SERIALFIELD

public static final String SERIALFIELD

SINCE

public static final String SINCE

THROWS

public static final String THROWS

VERSION

public static final String VERSION

Method Detail

add

public static void add(JavadocTags.TagDescription td)

getIndex

public static int getIndex(String tag)

getTagsAtIndex

public static List getTagsAtIndex(int index)

getValidClassTags

public static List getValidClassTags()

getValidConstructorTags

public static List getValidConstructorTags()

getValidFieldTags

public static List getValidFieldTags()

getValidInterfaceTags

public static List getValidInterfaceTags()

getValidMethodTags

public static List getValidMethodTags()