Skip to content

Commit effb762

Browse files
sslaviccbeams
authored andcommitted
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
1 parent e830511 commit effb762

File tree

92 files changed

+347
-350
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+347
-350
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
/**
3333
* AOP Alliance <code>MethodInterceptor</code> that processes method invocations
3434
* asynchronously, using a given {@link org.springframework.core.task.AsyncTaskExecutor}.
35-
* Typically used with the {@link org.springframework.context.task.Async} annotation.
35+
* Typically used with the {@link org.springframework.scheduling.annotation.Async} annotation.
3636
*
3737
* <p>In terms of target method signatures, any parameter types are supported.
3838
* However, the return type is constrained to either <code>void</code> or

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,8 +28,9 @@
2828
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
2929

3030
/**
31-
* Base class for dynamic {@link TargetSource} implementations that create new prototype
32-
* bean instances to support a pooling or new-instance-per-invocation strategy.
31+
* Base class for dynamic {@link org.springframework.aop.TargetSource} implementations
32+
* that create new prototype bean instances to support a pooling or
33+
* new-instance-per-invocation strategy.
3334
*
3435
* <p>Such TargetSources must run in a {@link BeanFactory}, as it needs to
3536
* call the <code>getBean</code> method to create a new prototype instance.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@
3131
* @author Chris Beams
3232
* @since 3.1
3333
* @see EnableAsync
34-
* @see AsyncConfigurationSelector
34+
* @see org.springframework.scheduling.annotation.AsyncConfigurationSelector
3535
*/
3636
@Configuration
3737
public class AspectJAsyncConfiguration extends AbstractAsyncConfiguration {

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@
3939
* a special case of such a general config method. Such config methods
4040
* do not have to be public.
4141
*
42-
* <p>In the case of multiple argument methods, the 'required' parameter is
42+
* <p>In the case of multiple argument methods, the 'required' parameter is
4343
* applicable for all arguments.
4444
*
4545
* <p>In case of a {@link java.util.Collection} or {@link java.util.Map}
@@ -52,8 +52,9 @@
5252
* BeanPostProcessor} which in turn means that you <em>cannot</em>
5353
* use {@code @Autowired} to inject references into
5454
* {@link org.springframework.beans.factory.config.BeanPostProcessor
55-
* BeanPostProcessor} or {@link BeanFactoryPostProcessor} types. Please
56-
* consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
55+
* BeanPostProcessor} or
56+
* {@link org.springframework.beans.factory.config.BeanFactoryPostProcessor BeanFactoryPostProcessor}
57+
* types. Please consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
5758
* class (which, by default, checks for the presence of this annotation).
5859
*
5960
* @author Juergen Hoeller

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -37,8 +37,9 @@
3737
* BeanPostProcessor} which in turn means that you <em>cannot</em> use
3838
* {@code @Value} within
3939
* {@link org.springframework.beans.factory.config.BeanPostProcessor
40-
* BeanPostProcessor} or {@link BeanFactoryPostProcessor} types. Please
41-
* consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
40+
* BeanPostProcessor} or
41+
* {@link org.springframework.beans.factory.config.BeanFactoryPostProcessor BeanFactoryPostProcessor}
42+
* types. Please consult the javadoc for the {@link AutowiredAnnotationBeanPostProcessor}
4243
* class (which, by default, checks for the presence of this annotation).
4344
*
4445
* @author Juergen Hoeller

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -36,8 +36,8 @@
3636
*
3737
*<pre class="code">{@code
3838
*<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>
39-
* <property name="driverClassName" value="}${driver}{@code"/>
40-
* <property name="url" value="jdbc:}${dbname}{@code"/>
39+
* <property name="driverClassName" value="}${driver}{@code "/>
40+
* <property name="url" value="jdbc:}${dbname}{@code "/>
4141
*</bean>
4242
*}</pre>
4343
*
@@ -76,7 +76,7 @@
7676
* <p>Example XML property with default value:
7777
*
7878
*<pre class="code">{@code
79-
* <property name="url" value="jdbc:}${dbname:defaultdb}{@code"/>
79+
* <property name="url" value="jdbc:}${dbname:defaultdb}{@code "/>
8080
*}</pre>
8181
*
8282
* @author Chris Beams

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -353,7 +353,7 @@ public void initDefaults(Element root) {
353353
* <literal>parentDefaults</literal> in case the defaults are not explicitly set
354354
* locally.
355355
* @param defaults the defaults to populate
356-
* @param defaults the parent BeanDefinitionParserDelegate (if any) defaults to fall back to
356+
* @param parentDefaults the parent BeanDefinitionParserDelegate (if any) defaults to fall back to
357357
* @param root the root element of the current bean definition document (or nested beans element)
358358
*/
359359
protected void populateDefaults(DocumentDefaultsDefinition defaults, DocumentDefaultsDefinition parentDefaults, Element root) {

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -34,7 +34,6 @@
3434
import org.springframework.beans.propertyeditors.InputStreamEditor;
3535
import org.springframework.beans.propertyeditors.URIEditor;
3636
import org.springframework.beans.propertyeditors.URLEditor;
37-
import org.springframework.core.env.Environment;
3837
import org.springframework.core.env.PropertyResolver;
3938
import org.springframework.core.env.StandardEnvironment;
4039
import org.springframework.core.io.ContextResource;
@@ -71,7 +70,7 @@ public class ResourceEditorRegistrar implements PropertyEditorRegistrar {
7170
* @see org.springframework.core.io.support.ResourcePatternResolver
7271
* @see org.springframework.context.ApplicationContext
7372
* @deprecated as of Spring 3.1 in favor of
74-
* {@link #ResourceEditorRegistrar(ResourceLoader, Environment)}
73+
* {@link #ResourceEditorRegistrar(ResourceLoader, PropertyResolver)}
7574
*/
7675
@Deprecated
7776
public ResourceEditorRegistrar(ResourceLoader resourceLoader) {

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -56,9 +56,7 @@
5656
* @since 3.1
5757
* @see #setName
5858
* @see #setGroup
59-
* @see #setStartTime
60-
* @see #setJobName
61-
* @see #setJobGroup
59+
* @see #setStartDelay
6260
* @see #setJobDetail
6361
* @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers
6462
* @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2011 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -56,9 +56,7 @@
5656
* @since 3.1
5757
* @see #setName
5858
* @see #setGroup
59-
* @see #setStartTime
60-
* @see #setJobName
61-
* @see #setJobGroup
59+
* @see #setStartDelay
6260
* @see #setJobDetail
6361
* @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers
6462
* @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails

0 commit comments

Comments
 (0)