Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc checkstyle issues

Browse Source 
Fix checkstyle violations for javadoc.

Issue: SPR-16968
This commit is contained in:
Phillip Webb
2018-06-20 18:45:54 -07:00
committed by Juergen Hoeller
parent 032096d699
commit e0480f75ac
928 changed files with 3729 additions and 2686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheFactoryBean.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -119,6 +119,7 @@ public class EhCacheFactoryBean extends CacheConfiguration implements FactoryBea
}
/**
* Set the time to live.
* @see #setTimeToLiveSeconds(long)
*/
public void setTimeToLive(int timeToLive) {
@@ -126,6 +127,7 @@ public class EhCacheFactoryBean extends CacheConfiguration implements FactoryBea
}
/**
* Set the time to idle.
* @see #setTimeToIdleSeconds(long)
*/
public void setTimeToIdle(int timeToIdle) {
@@ -133,6 +135,7 @@ public class EhCacheFactoryBean extends CacheConfiguration implements FactoryBea
}
/**
* Set the disk spool buffer size (in MB).
* @see #setDiskSpoolBufferSizeMB(int)
*/
public void setDiskSpoolBufferSize(int diskSpoolBufferSize) {

4
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractCacheInterceptor.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 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,6 +36,8 @@ import org.springframework.util.CollectionUtils;
*
* @author Stephane Nicoll
* @since 4.1
* @param <O> the operation type
* @param <A> the annotation type
*/
@SuppressWarnings("serial")
abstract class AbstractCacheInterceptor<O extends AbstractJCacheOperation<A>, A extends Annotation>

1
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractJCacheKeyOperation.java vendored
View File

@@ -30,6 +30,7 @@ import org.springframework.cache.interceptor.KeyGenerator;
*
* @author Stephane Nicoll
* @since 4.1
* @param <A> the annotation type
*/
abstract class AbstractJCacheKeyOperation<A extends Annotation> extends AbstractJCacheOperation<A> {

7
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractJCacheOperation.java vendored
View File

@@ -39,6 +39,7 @@ import static java.util.Arrays.*;
*
* @author Stephane Nicoll
* @since 4.1
* @param <A> the annotation type
*/
abstract class AbstractJCacheOperation<A extends Annotation> implements JCacheOperation<A> {
@@ -147,6 +148,9 @@ abstract class AbstractJCacheOperation<A extends Annotation> implements JCacheOp
}
/**
* Details for a single cache parameter.
*/
protected static class CacheParameterDetail {
private final Class<?> rawType;
@@ -196,6 +200,9 @@ abstract class AbstractJCacheOperation<A extends Annotation> implements JCacheOp
}
/**
* A single cache invocation parameter.
*/
protected static class CacheInvocationParameterImpl implements CacheInvocationParameter {
private final CacheParameterDetail detail;

4
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractKeyCacheInterceptor.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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,6 +28,8 @@ import org.springframework.cache.interceptor.KeyGenerator;
*
* @author Stephane Nicoll
* @since 4.1
* @param <O> the operation type
* @param <A> the annotation type
*/
@SuppressWarnings("serial")
abstract class AbstractKeyCacheInterceptor<O extends AbstractJCacheKeyOperation<A>, A extends Annotation>

3
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/DefaultCacheInvocationContext.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -32,6 +32,7 @@ import org.springframework.cache.interceptor.CacheOperationInvocationContext;
*
* @author Stephane Nicoll
* @since 4.1
* @param <A> the annotation type
*/
class DefaultCacheInvocationContext<A extends Annotation>
implements CacheInvocationContext<A>, CacheOperationInvocationContext<JCacheOperation<A>> {

3
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/DefaultCacheKeyInvocationContext.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 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.
@@ -25,6 +25,7 @@ import javax.cache.annotation.CacheKeyInvocationContext;
*
* @author Stephane Nicoll
* @since 4.1
* @param <A> the annotation type
*/
class DefaultCacheKeyInvocationContext<A extends Annotation>
extends DefaultCacheInvocationContext<A> implements CacheKeyInvocationContext<A> {

3
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/DefaultCacheMethodDetails.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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,6 +30,7 @@ import static java.util.Arrays.*;
*
* @author Stephane Nicoll
* @since 4.1
* @param <A> the annotation type
*/
class DefaultCacheMethodDetails<A extends Annotation> implements CacheMethodDetails<A> {

4
spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/SimpleExceptionCacheResolver.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 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,7 +28,7 @@ import org.springframework.cache.interceptor.CacheResolver;
/**
* A simple {@link CacheResolver} that resolves the exception cache
* based on a configurable {@link CacheManager} and the name of the
* cache: {@link CacheResultOperation#getExceptionCacheName()}
* cache: {@link CacheResultOperation#getExceptionCacheName()}.
*
* @author Stephane Nicoll
* @since 4.1

4
spring-context-support/src/main/java/org/springframework/mail/MailSendException.java
View File

@@ -65,7 +65,7 @@ public class MailSendException extends MailException {
* to the invoked send method.
* @param msg the detail message
* @param cause the root cause from the mail API in use
* @param failedMessages Map of failed messages as keys and thrown
* @param failedMessages a Map of failed messages as keys and thrown
* exceptions as values
*/
public MailSendException(@Nullable String msg, @Nullable Throwable cause, Map<Object, Exception> failedMessages) {
@@ -79,7 +79,7 @@ public class MailSendException extends MailException {
* messages that failed as keys, and the thrown exceptions as values.
* <p>The messages should be the same that were originally passed
* to the invoked send method.
* @param failedMessages Map of failed messages as keys and thrown
* @param failedMessages a Map of failed messages as keys and thrown
* exceptions as values
*/
public MailSendException(Map<Object, Exception> failedMessages) {

6
spring-context-support/src/main/java/org/springframework/mail/javamail/ConfigurableMimeFileTypeMap.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -93,7 +93,7 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali
/**
* Specify additional MIME type mappings as lines that follow the
* {@code mime.types} file format, as specified by the
* Java Activation Framework, for example:<br>
* Java Activation Framework. For example:<br>
* {@code text/html html htm HTML HTM}
*/
public void setMappings(String... mappings) {
@@ -136,7 +136,7 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali
* passing in an InputStream from the mapping resource (if any) and registering
* the mapping lines programmatically.
* @param mappingLocation a {@code mime.types} mapping resource (can be {@code null})
* @param mappings MIME type mapping lines (can be {@code null})
* @param mappings an array of MIME type mapping lines (can be {@code null})
* @return the compiled FileTypeMap
* @throws IOException if resource access failed
* @see javax.activation.MimetypesFileTypeMap#MimetypesFileTypeMap(java.io.InputStream)

6
spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSenderImpl.java
View File

@@ -68,10 +68,10 @@ import org.springframework.util.Assert;
*/
public class JavaMailSenderImpl implements JavaMailSender {
/** The default protocol: 'smtp' */
/** The default protocol: 'smtp'. */
public static final String DEFAULT_PROTOCOL = "smtp";
/** The default port: -1 */
/** The default port: -1. */
public static final int DEFAULT_PORT = -1;
private static final String HEADER_MESSAGE_ID = "Message-ID";
@@ -404,7 +404,7 @@ public class JavaMailSenderImpl implements JavaMailSender {
/**
* Actually send the given array of MimeMessages via JavaMail.
* @param mimeMessages MimeMessage objects to send
* @param mimeMessages the MimeMessage objects to send
* @param originalMessages corresponding original message objects
* that the MimeMessages have been created from (with same array
* length and indices as the "mimeMessages" array), if any

14
spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessageHelper.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -184,7 +184,7 @@ public class MimeMessageHelper {
* <p>The character encoding for the message will be taken from
* the passed-in MimeMessage object, if carried there. Else,
* JavaMail's default encoding will be used.
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @see #MimeMessageHelper(javax.mail.internet.MimeMessage, boolean)
* @see #getDefaultEncoding(javax.mail.internet.MimeMessage)
* @see JavaMailSenderImpl#setDefaultEncoding
@@ -197,7 +197,7 @@ public class MimeMessageHelper {
* Create a new MimeMessageHelper for the given MimeMessage,
* assuming a simple text message (no multipart content,
* i.e. no alternative texts and no inline elements or attachments).
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @param encoding the character encoding to use for the message
* @see #MimeMessageHelper(javax.mail.internet.MimeMessage, boolean)
*/
@@ -217,7 +217,7 @@ public class MimeMessageHelper {
* <p>The character encoding for the message will be taken from
* the passed-in MimeMessage object, if carried there. Else,
* JavaMail's default encoding will be used.
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @param multipart whether to create a multipart message that
* supports alternative texts, inline elements and attachments
* (corresponds to MULTIPART_MODE_MIXED_RELATED)
@@ -237,7 +237,7 @@ public class MimeMessageHelper {
* <p>Consider using the MimeMessageHelper constructor that
* takes a multipartMode argument to choose a specific multipart
* mode other than MULTIPART_MODE_MIXED_RELATED.
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @param multipart whether to create a multipart message that
* supports alternative texts, inline elements and attachments
* (corresponds to MULTIPART_MODE_MIXED_RELATED)
@@ -258,7 +258,7 @@ public class MimeMessageHelper {
* <p>The character encoding for the message will be taken from
* the passed-in MimeMessage object, if carried there. Else,
* JavaMail's default encoding will be used.
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @param multipartMode which kind of multipart message to create
* (MIXED, RELATED, MIXED_RELATED, or NO)
* @throws MessagingException if multipart creation failed
@@ -277,7 +277,7 @@ public class MimeMessageHelper {
* Create a new MimeMessageHelper for the given MimeMessage,
* in multipart mode (supporting alternative texts, inline
* elements and attachments) if requested.
* @param mimeMessage MimeMessage to work on
* @param mimeMessage the mime message to work on
* @param multipartMode which kind of multipart message to create
* (MIXED, RELATED, MIXED_RELATED, or NO)
* @param encoding the character encoding to use for the message

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -58,7 +58,7 @@ import org.springframework.util.Assert;
*/
public class CronTriggerFactoryBean implements FactoryBean<CronTrigger>, BeanNameAware, InitializingBean {
/** Constants for the CronTrigger class */
/** Constants for the CronTrigger class. */
private static final Constants constants = new Constants(CronTrigger.class);
@@ -141,7 +141,7 @@ public class CronTriggerFactoryBean implements FactoryBean<CronTrigger>, BeanNam
* Register objects in the JobDataMap via a given Map.
* <p>These objects will be available to this Trigger only,
* in contrast to objects in the JobDetail's data map.
* @param jobDataAsMap Map with String keys and any objects as values
* @param jobDataAsMap a Map with String keys and any objects as values
* (for example Spring-managed beans)
*/
public void setJobDataAsMap(Map<String, ?> jobDataAsMap) {

4
spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailFactoryBean.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -124,7 +124,7 @@ public class JobDetailFactoryBean
* <p>Note: When using persistent Jobs whose JobDetail will be kept in the
* database, do not put Spring-managed beans or an ApplicationContext
* reference into the JobDataMap but rather into the SchedulerContext.
* @param jobDataAsMap Map with String keys and any objects as values
* @param jobDataAsMap a Map with String keys and any objects as values
* (for example Spring-managed beans)
* @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setSchedulerContextAsMap
*/

2
spring-context-support/src/main/java/org/springframework/scheduling/quartz/LocalTaskExecutorThreadPool.java
View File

@@ -37,7 +37,7 @@ import org.springframework.util.Assert;
*/
public class LocalTaskExecutorThreadPool implements ThreadPool {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
@Nullable

4
spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -141,7 +141,7 @@ public abstract class SchedulerAccessor implements ResourceLoaderAware {
/**
* Register a list of Quartz Calendar objects with the Scheduler
* that this FactoryBean creates, to be referenced by Triggers.
* @param calendars Map with calendar names as keys as Calendar
* @param calendars a Map with calendar names as keys as Calendar
* objects as values
* @see org.quartz.Calendar
*/

8
spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java
View File

@@ -90,8 +90,14 @@ import org.springframework.util.CollectionUtils;
public class SchedulerFactoryBean extends SchedulerAccessor implements FactoryBean<Scheduler>,
BeanNameAware, ApplicationContextAware, InitializingBean, DisposableBean, SmartLifecycle {
/**
* The thread count property.
*/
public static final String PROP_THREAD_COUNT = "org.quartz.threadPool.threadCount";
/**
* The default thread count.
*/
public static final int DEFAULT_THREAD_COUNT = 10;
@@ -340,7 +346,7 @@ public class SchedulerFactoryBean extends SchedulerAccessor implements FactoryBe
* <p>Note: When using persistent Jobs whose JobDetail will be kept in the
* database, do not put Spring-managed beans or an ApplicationContext
* reference into the JobDataMap but rather into the SchedulerContext.
* @param schedulerContextAsMap Map with String keys and any objects as
* @param schedulerContextAsMap a Map with String keys and any objects as
* values (for example Spring-managed beans)
* @see JobDetailFactoryBean#setJobDataAsMap
*/

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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,7 +56,7 @@ import org.springframework.util.Assert;
*/
public class SimpleTriggerFactoryBean implements FactoryBean<SimpleTrigger>, BeanNameAware, InitializingBean {
/** Constants for the SimpleTrigger class */
/** Constants for the SimpleTrigger class. */
private static final Constants constants = new Constants(SimpleTrigger.class);
@@ -134,7 +134,7 @@ public class SimpleTriggerFactoryBean implements FactoryBean<SimpleTrigger>, Bea
* Register objects in the JobDataMap via a given Map.
* <p>These objects will be available to this Trigger only,
* in contrast to objects in the JobDetail's data map.
* @param jobDataAsMap Map with String keys and any objects as values
* @param jobDataAsMap a Map with String keys and any objects as values
* (for example Spring-managed beans)
*/
public void setJobDataAsMap(Map<String, ?> jobDataAsMap) {