Package org.glassfish.quality

Annotation Interface ToDo

@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER,TYPE})
@Documented
public @interface ToDo

Annotation indicating the code needs attention for some reasson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ToDo.Kind
static enum	ToDo.Priority

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	contact	Optional info to locate responsible party, could be email, name, team, etc Could an IDE insert ${user} when editing?
String	details	concise summary of what's required
ToDo.Kind	kind	What kind of activity is required
ToDo.Priority	priority	How important

Element Details

priority

ToDo.Priority priority

How important

Default:

UNKNOWN

kind

ToDo.Kind kind

What kind of activity is required

Default:

CODE

details

String details

concise summary of what's required

Default:

"unspecified"

contact

String contact

Optional info to locate responsible party, could be email, name, team, etc Could an IDE insert ${user} when editing?

Default:

""