org.glassfish.quality

Annotation Type ToDo

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

Annotation indicating the code needs attention for some reasson

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and 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 Detail

priority

public abstract ToDo.Priority priority

How important

Default:

org.glassfish.quality.ToDo.Priority.UNKNOWN

kind

public abstract ToDo.Kind kind

What kind of activity is required

Default:

org.glassfish.quality.ToDo.Kind.CODE

details

public abstract String details

concise summary of what's required

Default:

"unspecified"

contact

public abstract String contact

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

Default:

""