gov.sandia.cognition.annotation

Annotation Type CodeReviewResponse

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-08",
            changesNeeded=true,
            comments={"Not sure about the Documented or Runtime Retention annotations for the class. Review this please.","Otherwise, class looks fine."},
            response=@CodeReviewResponse(respondent="Justin Basilico",date="2008-02-18",moreChangesNeeded=false,comments={"Runtime retention means that we could look via reflection to see what has been code reviewed.","Documented makes the review show up in the documentation."}))
 @Retention(value=RUNTIME)
 @Documented
public @interface CodeReviewResponse

The CodeReviewResponse annotation contains information regarding a response to a CodeReview annotation.

Since:

2.1

Author:

Kevin R. Dixon, Justin Basilico

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	comments The comments of the response.
java.lang.String	date The date of the response.
boolean	moreChangesNeeded True if more changes are needed; otherwise, false.
java.lang.String	respondent The full name of the respondent of the code review.

Element Detail

respondent

public abstract java.lang.String respondent

The full name of the respondent of the code review. For example, "Justin Basilico".

Returns:

The full name of the respondent.

date

public abstract java.lang.String date

The date of the response. Use "YYYY-mm-dd" format. For example, "2008-01-14".

Returns:

The date of the code review response.

moreChangesNeeded

public abstract boolean moreChangesNeeded

True if more changes are needed; otherwise, false.

Returns:

True if more changes are needed; otherwise, false.

comments

public abstract java.lang.String[] comments

The comments of the response.

Returns:

The comments of the response.