BATCH-2011: Updated javadoc to conform to java.lang.Comparable

2014-03-06 14:03:12 -06:00
parent 36a7c2ee32
commit dfcb21b736
1 changed files with 2 additions and 1 deletions
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/ExitStatus.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/ExitStatus.java
@@ -138,7 +138,8 @@ public class ExitStatus implements Serializable, Comparable<ExitStatus> {

 	/**
 	 * @param status an {@link ExitStatus} to compare
-	 * @return 1,0,-1 according to the severity and exit code
+	 * @return greater than zero, 0, less than zero according to the severity and exit code
+	 * @see java.lang.Comparable
 	 */
 	@Override
 	public int compareTo(ExitStatus status) {