com.bluegosling.util

Annotation Type ToDo

@Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,TYPE,PACKAGE,CONSTRUCTOR,METHOD,FIELD})
 @Documented
 @Repeatable(value=ToDos.class)
 @ToDo(value="Implement annotation processor that emits TODOs during compile, possibly as warnings.") @ToDo(value="Update TODO comments in this project to use @ToDo annotations instead.")
public @interface ToDo

Describes a "TODO" task for the annotated element.

Examples:

  @ToDo("implement serialization and cloning")
 class MyCoolClazz {
 }
 
  @ToDo("add tests!"),
  @ToDo("reconcile method names so API is more consistent"),
  @ToDo("add static helper methods for x, y, and z")
 class MyCoolerClazz {
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value A description of the task that needs to be done.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	who An optional name of a person responsible for this task.

Element Detail

value

public abstract String value

A description of the task that needs to be done.

who

public abstract String who

An optional name of a person responsible for this task.

Default:

""