org.tranche.annotations
Annotation Type Todo

@Retention(value=SOURCE)
public @interface Todo

Available only at compile-time, this type is used to include notes about what might or should be done to the code base. Eventually such notes can be collecte up using a JDK 5 APT module in to reports/or some kind of "to do" list.

Author:

Brian Maso

Required Element Summary

java.lang.String	author The author of the annotation.
int	day Day of month.
java.lang.String	desc A brief description of the todo item.
int	month Month starting with 1 (January) and ending with 12 (December).
int	year E.g., 2002 for 2002 AD.

Element Detail

desc

public abstract java.lang.String desc

A brief description of the todo item.

Returns:

day

public abstract int day

Day of month. Start with 1 for the first (i.e., not zero-indexed). If unknown, use 0.

Returns:

month

public abstract int month

Month starting with 1 (January) and ending with 12 (December). If unknown, use 0.

Returns:

year

public abstract int year

E.g., 2002 for 2002 AD. If unknown, use 0.

Returns:

author

public abstract java.lang.String author

The author of the annotation. If unknown, use "unknown".

Returns: