org.incava.doctorj

Class JavadocTags


public class JavadocTags
extends java.lang.Object

Javadoc tags and the order in which they should appear for each Java type.

Nested Class Summary

static class
JavadocTags.TagDescription

Field Summary

static String
AUTHOR
static int
CUSTOM_TAG
static String
DEPRECATED
static String
EXCEPTION
static String
PARAM
static String
RETURN
static String
SEE
static String
SERIAL
static String
SERIALDATA
static String
SERIALFIELD
static String
SINCE
static String
THROWS
static String
VERSION

Method Summary

static void
add(JavadocTags.TagDescription td)
static int
getIndex(String tag)
static List
getTagsAtIndex(int index)
static List
getValidClassTags()
static List
getValidConstructorTags()
static List
getValidFieldTags()
static List
getValidInterfaceTags()
static List
getValidMethodTags()

Field Details

AUTHOR

public static final String AUTHOR

CUSTOM_TAG

public static final int CUSTOM_TAG
Field Value:
999

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 Details

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()