RESOLVED - BATCH-85: Many warnings in Javadocs (e.g. missing links and parameter names)

cleaned up the samples module

spring-batch-samples/.settings/org.eclipse.jdt.core.prefs

@@ -1,7 +1,8 @@
-#Fri Mar 07 10:10:51 GMT 2008
+#Tue Apr 22 13:47:16 CEST 2008
 eclipse.preferences.version=1
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.4
 org.eclipse.jdt.core.compiler.compliance=1.4
+org.eclipse.jdt.core.compiler.doc.comment.support=enabled
 org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
 org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
 org.eclipse.jdt.core.compiler.problem.deprecation=warning
@@ -19,9 +20,20 @@ org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
 org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
 org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=error
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=default
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
 org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
 org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
 org.eclipse.jdt.core.compiler.problem.missingSerialVersion=ignore
 org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning

spring-batch-samples/src/main/java/org/springframework/batch/sample/ClassPathXmlApplicationContextJobFactory.java

@@ -103,21 +103,18 @@ public class ClassPathXmlApplicationContextJobFactory implements JobFactory {
 			}
 		}
 		/**
-		 * @return
 		 * @see org.springframework.batch.core.Job#getName()
 		 */
 		public String getName() {
 			return delegate.getName();
 		}
 		/**
-		 * @return
 		 * @see org.springframework.batch.core.Job#getSteps()
 		 */
 		public List getSteps() {
 			return delegate.getSteps();
 		}
 		/**
-		 * @return
 		 * @see org.springframework.batch.core.Job#isRestartable()
 		 */
 		public boolean isRestartable() {

spring-batch-samples/src/main/java/org/springframework/batch/sample/advice/JobExecutionNotificationPublisher.java

@@ -49,11 +49,11 @@ public class JobExecutionNotificationPublisher implements ApplicationListener, N
 	}
 
 	/**
-	 * If the event is a {@link RepeatOperationsApplicationEvent} for open and
+	 * If the event is a {@link SimpleMessageApplicationEvent} for open and
 	 * close we log the event at INFO level and send a JMX notification if we
 	 * are also an MBean.
 	 * 
-	 * @see org.springframework.batch.core.launch.support.SimpleJobLauncher#onApplicationEvent(org.springframework.context.ApplicationEvent)
+	 * @see ApplicationListener#onApplicationEvent(ApplicationEvent) 
 	 */
 	public void onApplicationEvent(ApplicationEvent applicationEvent) {
 		if (applicationEvent instanceof SimpleMessageApplicationEvent) {

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/Person.java

@@ -106,7 +106,7 @@ public class Person {
 		return title;
 	}
 	/**
-	 * @param person_title the person_title to set
+	 * @param title the person title to set
 	 */
 	public void setTitle(String title) {
 		this.title = title;

spring-batch-samples/src/main/java/org/springframework/batch/sample/item/reader/StagingItemReader.java

@@ -65,7 +65,7 @@ public class StagingItemReader extends JdbcDaoSupport implements ItemStream, Ite
 
 	/**
 	 * 
-	 * @see org.springframework.batch.item.database.DrivingQueryItemReader#open()
+	 * @see org.springframework.batch.item.database.DrivingQueryItemReader#open(ExecutionContext)
 	 */
 	public void open(ExecutionContext executionContext) {
 		// Can be called from multiple threads because of lazy initialisation...

spring-batch-samples/src/main/java/org/springframework/batch/sample/item/writer/RetrySampleItemWriter.java

@@ -20,7 +20,7 @@ public class RetrySampleItemWriter extends AbstractItemWriter {
 	}
 
 	/**
-	 * @return number of times {@link #handle(Object)} method was called.
+	 * @return number of times {@link #write(Object)} method was called.
 	 */
 	public int getCounter() {
 		return counter;

spring-batch-samples/src/main/java/org/springframework/batch/sample/item/writer/TradeWriter.java

@@ -31,7 +31,7 @@ public class TradeWriter extends AbstractItemWriter {
     private int index = 0;
     
     /**
-	 * Public setter for the {@link int} property.
+	 * Public setter for the the index on which failure should occur.
 	 *
 	 * @param failure the failure to set
 	 */