Editing pass for Javdocs

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunkError.java

@@ -24,7 +24,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Marks a method to be called after a has failed and been
+ * Marks a method to be called after a chunk has failed and been
  * marked for rollback.<br>
  * <br>
  * Expected signature: void afterFailedChunk(ChunkContext context)

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java

@@ -27,10 +27,10 @@
 
 /**
  * Marks a method to be called after a {@link Job} has completed. Annotated
- * methods will be called regardless of the status of the {@link JobExecution}. <br>
+ * methods are called regardless of the status of the {@link JobExecution}. <br>
  * <br>
  * Expected signature: void afterJob({@link JobExecution} jobExecution)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see JobExecutionListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java

@@ -26,11 +26,13 @@
 
 /**
  * Marks a method to be called after an item is passed to an
- * {@link ItemProcessor} <br>
+ * {@link ItemProcessor}. {@code item} is the input item.
+ * {@code result} is the processed item. {@code result} can be null
+ * if the {@code item} is filtered.<br>
  * <br>
  * Expected signature: void afterProcess(T item, S result)
- * 
- * @author Lucas Ward
+ *
+ * @author Lucas Ward, Jay Bryant
  * @since 2.0
  * @see ItemProcessListener
  */

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java

@@ -28,11 +28,11 @@
 
 /**
  * Marks a method to be called after a {@link Step} has completed. Annotated
- * methods will be called regardless of the status of the {@link StepExecution}. <br>
+ * methods are called regardless of the status of the {@link StepExecution}. <br>
  * <br>
  * Expected signature: {@link ExitStatus} afterStep({@link StepExecution}
  * stepExecution);
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see StepExecutionListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java

@@ -26,10 +26,12 @@
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called after an item is passed to an {@link ItemWriter} <br>
+ * Marks a method to be called after an item is passed to an {@link ItemWriter}.
+ * Note that this annotation takes a {@link List} because Spring Batch
+ * generally processes a group of items (for the sake of efficiency).<br>
  * <br>
  * Expected signature: void afterWrite({@link List}&lt;? extends S&gt; items)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see ItemWriteListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java

@@ -29,11 +29,11 @@
 
 /**
  * Marks a method to be called before a {@link Job} is executed, which comes
- * after a {@link JobExecution} is created and persisted, but before the first
+ * after a {@link JobExecution} is created and persisted but before the first
  * {@link Step} is executed. <br>
  * <br>
  * Expected signature: void beforeJob({@link JobExecution} jobExecution)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see JobExecutionListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java

@@ -27,11 +27,11 @@
 
 /**
  * Marks a method to be called before a {@link Step} is executed, which comes
- * after a {@link StepExecution} is created and persisted, but before the first
+ * after a {@link StepExecution} is created and persisted but before the first
  * item is read. <br>
  * <br>
  * Expected signature: void beforeStep({@link StepExecution} stepExecution)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see StepExecutionListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java

@@ -26,10 +26,10 @@
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called before an item is passed to an {@link ItemWriter} <br>
+ * Marks a method to be called before an item is passed to an {@link ItemWriter}. <br>
  * <br>
  * Expected signature: void beforeWrite({@link List}&lt;? extends S&gt; items)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see ItemWriteListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java

@@ -26,10 +26,10 @@
 
 /**
  * Marks a method to be called if an exception is thrown by an
- * {@link ItemProcessor} <br>
+ * {@link ItemProcessor}. <br>
  * <br>
  * Expected signature: void onProcessError(T item, {@link Exception} e)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see ItemProcessListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java

@@ -25,10 +25,10 @@
 
 /**
  * Marks a method to be called if an exception is thrown by an
- * {@link ItemReader} <br>
+ * {@link ItemReader}. <br>
  * <br>
  * Expected signature: void onReadError({@link Exception} ex)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see ItemReadListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java

@@ -29,7 +29,7 @@
  * thrown in the {@link ItemProcessor}.<br>
  * <br>
  * Expected signature: void onSkipInProcess(T item, {@link Throwable} t)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see SkipListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java

@@ -26,10 +26,10 @@
 
 /**
  * Marks a method to be called when an item is skipped due to an exception
- * thrown in the {@link ItemReader} <br>
+ * thrown in the {@link ItemReader}. <br>
  * <br>
  * Expected signature: void onSkipInRead({@link Throwable} t)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see SkipListener

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java

@@ -27,11 +27,13 @@
 
 /**
  * Marks a method to be called if an exception is thrown by an
- * {@link ItemWriter} <br>
+ * {@link ItemWriter}. Note that this annotation takes a {@link List}
+ * because Spring Batch generally processes a group of items
+ * (for the sake of efficiency).<br>
  * <br>
  * Expected signature: void onWriteError({@link Exception} exception,
  * {@link List}&lt;? extends S&gt; items)
- * 
+ *
  * @author Lucas Ward
  * @since 2.0
  * @see ItemWriteListener
@@ -40,4 +42,4 @@
 @Target({ElementType.METHOD})
 public @interface OnWriteError {
 
-}
+}