Fix javadoc warnings

Before this change there were numerous javadoc warnings being reported
while building Spring framework API.

This commit resolves most of the javadoc warnings, reducing the total
number from 265 to 103.

Issue: SPR-9113

Author: sslavic

spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionInterceptor.java

@@ -32,7 +32,7 @@
 /**
  * AOP Alliance <code>MethodInterceptor</code> that processes method invocations
  * asynchronously, using a given {@link org.springframework.core.task.AsyncTaskExecutor}.
- * Typically used with the {@link org.springframework.context.task.Async} annotation.
+ * Typically used with the {@link org.springframework.scheduling.annotation.Async} annotation.
  *
  * <p>In terms of target method signatures, any parameter types are supported.
  * However, the return type is constrained to either <code>void</code> or

spring-aop/src/main/java/org/springframework/aop/target/AbstractPrototypeBasedTargetSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,8 +28,9 @@
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 
 /**
- * Base class for dynamic {@link TargetSource} implementations that create new prototype
- * bean instances to support a pooling or new-instance-per-invocation strategy.
+ * Base class for dynamic {@link org.springframework.aop.TargetSource} implementations
+ * that create new prototype bean instances to support a pooling or
+ * new-instance-per-invocation strategy.
  *
  * <p>Such TargetSources must run in a {@link BeanFactory}, as it needs to
  * call the <code>getBean</code> method to create a new prototype instance.

spring-aspects/src/main/java/org/springframework/scheduling/aspectj/AspectJAsyncConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@
  * @author Chris Beams
  * @since 3.1
  * @see EnableAsync
- * @see AsyncConfigurationSelector
+ * @see org.springframework.scheduling.annotation.AsyncConfigurationSelector
  */
 @Configuration
 public class AspectJAsyncConfiguration extends AbstractAsyncConfiguration {

spring-beans/src/main/java/org/springframework/beans/factory/annotation/Autowired.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@
  * a special case of such a general config method. Such config methods
  * do not have to be public.
  *
- * <p>In the case of multiple argument methods, the 'required' parameter is 
+ * <p>In the case of multiple argument methods, the 'required' parameter is
  * applicable for all arguments.
  *
  * <p>In case of a {@link java.util.Collection} or {@link java.util.Map}
@@ -52,8 +52,9 @@
  * BeanPostProcessor} which in turn means that you <em>cannot</em>
  * use {@code @Autowired} to inject references into
  * {@link org.springframework.beans.factory.config.BeanPostProcessor
- * BeanPostProcessor} or {@link BeanFactoryPostProcessor} types. Please
- * consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
+ * BeanPostProcessor} or
+ * {@link org.springframework.beans.factory.config.BeanFactoryPostProcessor BeanFactoryPostProcessor}
+ * types. Please consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
  * class (which, by default, checks for the presence of this annotation).
  *
  * @author Juergen Hoeller

spring-beans/src/main/java/org/springframework/beans/factory/annotation/Value.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,8 +37,9 @@
  * BeanPostProcessor} which in turn means that you <em>cannot</em> use
  * {@code @Value} within
  * {@link org.springframework.beans.factory.config.BeanPostProcessor
- * BeanPostProcessor} or {@link BeanFactoryPostProcessor} types. Please
- * consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
+ * BeanPostProcessor} or
+ * {@link org.springframework.beans.factory.config.BeanFactoryPostProcessor BeanFactoryPostProcessor}
+ * types. Please consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
  * class (which, by default, checks for the presence of this annotation).
  *
  * @author Juergen Hoeller

spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,8 +36,8 @@
  *
  *<pre class="code">{@code
  *<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>
- *    <property name="driverClassName" value="}${driver}{@code"/>
- *    <property name="url" value="jdbc:}${dbname}{@code"/>
+ *    <property name="driverClassName" value="}${driver}{@code "/>
+ *    <property name="url" value="jdbc:}${dbname}{@code "/>
  *</bean>
  *}</pre>
  *
@@ -76,7 +76,7 @@
  * <p>Example XML property with default value:
  *
  *<pre class="code">{@code
- *  <property name="url" value="jdbc:}${dbname:defaultdb}{@code"/>
+ *  <property name="url" value="jdbc:}${dbname:defaultdb}{@code "/>
  *}</pre>
  *
  * @author Chris Beams

spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -353,7 +353,7 @@ public void initDefaults(Element root) {
 	 * <literal>parentDefaults</literal> in case the defaults are not explicitly set
 	 * locally.
 	 * @param defaults the defaults to populate
-	 * @param defaults the parent BeanDefinitionParserDelegate (if any) defaults to fall back to
+	 * @param parentDefaults the parent BeanDefinitionParserDelegate (if any) defaults to fall back to
 	 * @param root the root element of the current bean definition document (or nested beans element)
 	 */
 	protected void populateDefaults(DocumentDefaultsDefinition defaults, DocumentDefaultsDefinition parentDefaults, Element root) {

spring-beans/src/main/java/org/springframework/beans/support/ResourceEditorRegistrar.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,7 +34,6 @@
 import org.springframework.beans.propertyeditors.InputStreamEditor;
 import org.springframework.beans.propertyeditors.URIEditor;
 import org.springframework.beans.propertyeditors.URLEditor;
-import org.springframework.core.env.Environment;
 import org.springframework.core.env.PropertyResolver;
 import org.springframework.core.env.StandardEnvironment;
 import org.springframework.core.io.ContextResource;
@@ -71,7 +70,7 @@ public class ResourceEditorRegistrar implements PropertyEditorRegistrar {
 	 * @see org.springframework.core.io.support.ResourcePatternResolver
 	 * @see org.springframework.context.ApplicationContext
 	 * @deprecated as of Spring 3.1 in favor of
-	 * {@link #ResourceEditorRegistrar(ResourceLoader, Environment)}
+	 * {@link #ResourceEditorRegistrar(ResourceLoader, PropertyResolver)}
 	 */
 	@Deprecated
 	public ResourceEditorRegistrar(ResourceLoader resourceLoader) {

spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,9 +56,7 @@
  * @since 3.1
  * @see #setName
  * @see #setGroup
- * @see #setStartTime
- * @see #setJobName
- * @see #setJobGroup
+ * @see #setStartDelay
  * @see #setJobDetail
  * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers
  * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails

spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,9 +56,7 @@
  * @since 3.1
  * @see #setName
  * @see #setGroup
- * @see #setStartTime
- * @see #setJobName
- * @see #setJobGroup
+ * @see #setStartDelay
  * @see #setJobDetail
  * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers
  * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails

spring-context/src/main/java/org/springframework/cache/annotation/CacheAnnotationParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ public interface CacheAnnotationParser {
 	 * @param ae the annotated method or class
 	 * @return CacheOperation the configured caching operation,
 	 * or {@code null} if none was found
-	 * @see AnnotationCacheOperationSource#determineCacheOperation
+	 * @see AnnotationCacheOperationSource#determineCacheOperations(AnnotatedElement)
 	 */
 	Collection<CacheOperation> parseCacheAnnotations(AnnotatedElement ae);
 }

spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurationSelector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,7 +30,7 @@
  * @since 3.1
  * @see EnableCaching
  * @see ProxyCachingConfiguration
- * @see AnnotationConfigUtils.CACHE_ASPECT_CONFIGURATION_CLASS_NAME
+ * @see AnnotationConfigUtils#CACHE_ASPECT_CONFIGURATION_CLASS_NAME
  */
 public class CachingConfigurationSelector extends AdviceModeImportSelector<EnableCaching> {
 

spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -163,7 +163,7 @@
 
 	/**
 	 * Indicate how caching advice should be applied. The default is
-	 * {@link AdviceMode.PROXY}.
+	 * {@link AdviceMode#PROXY}.
 	 * @see AdviceMode
 	 */
 	AdviceMode mode() default AdviceMode.PROXY;

spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCache.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -115,7 +115,7 @@ public void clear() {
 	/**
 	 * Convert the given value from the internal store to a user value
 	 * returned from the get method (adapting <code>null</code>).
-	 * @param userValue the store value
+	 * @param storeValue the store value
 	 * @return the value to return to the user
 	 */
 	protected Object fromStoreValue(Object storeValue) {

spring-context/src/main/java/org/springframework/cache/ehcache/EhCacheCacheManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,8 +39,8 @@ public class EhCacheCacheManager extends AbstractCacheManager {
 
 
 	/**
-	 * Returns the backing Ehcache {@link net.sf.ehcache.CacheManager}.
-	 * @return
+	 * Returns the backing EhCache {@link net.sf.ehcache.CacheManager}.
+	 * @return the backing EhCache {@link net.sf.ehcache.CacheManager}.
 	 */
 	public net.sf.ehcache.CacheManager getCacheManager() {
 		return cacheManager;

spring-context/src/main/java/org/springframework/cache/interceptor/BeanFactoryCacheOperationSourceAdvisor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,7 +44,6 @@ protected CacheOperationSource getCacheOperationSource() {
 	 * Set the cache operation attribute source which is used to find cache
 	 * attributes. This should usually be identical to the source reference
 	 * set on the cache interceptor itself.
-	 * @see CacheInterceptor#setCacheAttributeSource
 	 */
 	public void setCacheOperationSource(CacheOperationSource cacheOperationSource) {
 		this.cacheOperationSource = cacheOperationSource;

spring-context/src/main/java/org/springframework/cache/interceptor/CacheProxyFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2011 the original author or authors.
+ * Copyright 2010-2012 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@
  * Proxy factory bean for simplified declarative caching handling.
  * This is a convenient alternative to a standard AOP
  * {@link org.springframework.aop.framework.ProxyFactoryBean}
- * with a separate {@link CachingInterceptor} definition.
+ * with a separate {@link CacheInterceptor} definition.
  *
  * <p>This class is designed to facilitate declarative cache demarcation: namely, wrapping
  * a singleton target object with a caching proxy, proxying all the interfaces that the
@@ -36,7 +36,7 @@
  *
  * @author Costin Leau
  * @see org.springframework.aop.framework.ProxyFactoryBean
- * @see CachingInterceptor
+ * @see CacheInterceptor
  */
 @SuppressWarnings("serial")
 public class CacheProxyFactoryBean extends AbstractSingletonProxyFactoryBean {

spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java

@@ -50,7 +50,6 @@ public class NameMatchCacheOperationSource implements CacheOperationSource, Seri
 	 * (e.g. "myMethod") and CacheOperation instances
 	 * (or Strings to be converted to CacheOperation instances).
 	 * @see CacheOperation
-	 * @see CacheOperationEditor
 	 */
 	public void setNameMap(Map<String, Collection<CacheOperation>> nameMap) {
 		for (Map.Entry<String, Collection<CacheOperation>> entry : nameMap.entrySet()) {