Skip to content

Commit c48c5e7

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-context
Closes gh-28802
1 parent bc15f83 commit c48c5e7

File tree

50 files changed

+82
-81
lines changed

Some content is hidden

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

50 files changed

+82
-81
lines changed

spring-context-indexer/src/test/java/org/springframework/context/index/sample/SampleNonStaticEmbedded.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import org.springframework.stereotype.Component;
2020

2121
/**
22-
* Candidate with a inner class that isn't static (and should therefore not be added).
22+
* Candidate with an inner class that isn't static (and should therefore not be added).
2323
*
2424
* @author Stephane Nicoll
2525
*/

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/DefaultJCacheOperationSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ protected KeyGenerator getDefaultKeyGenerator() {
235235
* {@code CacheResolver} from a custom {@code CacheResolver} implementation so we have to
236236
* fall back on the {@code CacheManager}.
237237
* <p>This gives this weird situation of a perfectly valid configuration that breaks all
238-
* the sudden because the JCache support is enabled. To avoid this we resolve the default
238+
* of a sudden because the JCache support is enabled. To avoid this we resolve the default
239239
* exception {@code CacheResolver} as late as possible to avoid such hard requirement
240240
* in other cases.
241241
*/

spring-context-support/src/main/java/org/springframework/cache/transaction/TransactionAwareCacheDecorator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
/**
2828
* Cache decorator which synchronizes its {@link #put}, {@link #evict} and
2929
* {@link #clear} operations with Spring-managed transactions (through Spring's
30-
* {@link TransactionSynchronizationManager}, performing the actual cache
30+
* {@link TransactionSynchronizationManager}), performing the actual cache
3131
* put/evict/clear operation only in the after-commit phase of a successful
3232
* transaction. If no transaction is active, {@link #put}, {@link #evict} and
3333
* {@link #clear} operations will be performed immediately, as usual.

spring-context-support/src/main/java/org/springframework/cache/transaction/TransactionAwareCacheManagerProxy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
/**
2828
* Proxy for a target {@link CacheManager}, exposing transaction-aware {@link Cache} objects
2929
* which synchronize their {@link Cache#put} operations with Spring-managed transactions
30-
* (through Spring's {@link org.springframework.transaction.support.TransactionSynchronizationManager},
30+
* (through Spring's {@link org.springframework.transaction.support.TransactionSynchronizationManager}),
3131
* performing the actual cache put operation only in the after-commit phase of a successful transaction.
3232
* If no transaction is active, {@link Cache#put} operations will be performed immediately, as usual.
3333
*

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,10 @@ public void setJavaMailProperties(Properties javaMailProperties) {
132132
}
133133

134134
/**
135-
* Allow Map access to the JavaMail properties of this sender,
135+
* Allow {code Map} access to the JavaMail properties of this sender,
136136
* with the option to add or override specific entries.
137137
* <p>Useful for specifying entries directly, for example via
138-
* "javaMailProperties[mail.smtp.auth]".
138+
* {code javaMailProperties[mail.smtp.auth]}.
139139
*/
140140
public Properties getJavaMailProperties() {
141141
return this.javaMailProperties;
@@ -156,7 +156,7 @@ public synchronized void setSession(Session session) {
156156

157157
/**
158158
* Return the JavaMail {@code Session},
159-
* lazily initializing it if hasn't been specified explicitly.
159+
* lazily initializing it if it hasn't been specified explicitly.
160160
*/
161161
public synchronized Session getSession() {
162162
if (this.session == null) {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ public void setDurability(boolean durability) {
141141
}
142142

143143
/**
144-
* Set the recovery flag for this job, i.e. whether or not the job should
144+
* Set the recovery flag for this job, i.e. whether the job should
145145
* get re-executed if a 'recovery' or 'fail-over' situation is encountered.
146146
*/
147147
public void setRequestsRecovery(boolean requestsRecovery) {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public void setGroup(String group) {
119119
}
120120

121121
/**
122-
* Specify whether or not multiple jobs should be run in a concurrent fashion.
122+
* Specify whether multiple jobs should be run in a concurrent fashion.
123123
* The behavior when one does not want concurrent jobs to be executed is
124124
* realized through adding the {@code @PersistJobDataAfterExecution} and
125125
* {@code @DisallowConcurrentExecution} markers.
@@ -286,7 +286,7 @@ protected void executeInternal(JobExecutionContext context) throws JobExecutionE
286286

287287
/**
288288
* Extension of the MethodInvokingJob, implementing the StatefulJob interface.
289-
* Quartz checks whether or not jobs are stateful and if so,
289+
* Quartz checks whether jobs are stateful and if so,
290290
* won't let jobs interfere with each other.
291291
*/
292292
@PersistJobDataAfterExecution

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* <p><b>Note that the preferred way to apply dependency injection
4242
* to Job instances is via a JobFactory:</b> that is, to specify
4343
* {@link SpringBeanJobFactory} as Quartz JobFactory (typically via
44-
* {@link SchedulerFactoryBean#setJobFactory} SchedulerFactoryBean's "jobFactory" property}).
44+
* {@link SchedulerFactoryBean#setJobFactory SchedulerFactoryBean's "jobFactory" property}).
4545
* This allows to implement dependency-injected Quartz Jobs without
4646
* a dependency on Spring base classes.
4747
*

spring-context-support/src/testFixtures/java/org/springframework/contextsupport/testfixture/jcache/AbstractJCacheAnnotationTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ public void earlyRemoveWithExceptionVetoRemove() {
354354

355355
assertThatNullPointerException().isThrownBy(() ->
356356
service.earlyRemoveWithException(this.keyItem, false));
357-
// This will be remove anyway as the earlyRemove has removed the cache before
357+
// This will be removed anyway as the earlyRemove has removed the cache before
358358
assertThat(cache.get(key)).isNull();
359359
}
360360

@@ -428,7 +428,7 @@ public void earlyRemoveAllWithExceptionVetoRemove() {
428428

429429
assertThatNullPointerException().isThrownBy(() ->
430430
service.earlyRemoveAllWithException(false));
431-
// This will be remove anyway as the earlyRemove has removed the cache before
431+
// This will be removed anyway as the earlyRemove has removed the cache before
432432
assertThat(isEmpty(cache)).isTrue();
433433
}
434434

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
/**
2626
* An implementation of {@link CachingConfigurer} with empty methods allowing
27-
* sub-classes to override only the methods they're interested in.
27+
* subclasses to override only the methods they're interested in.
2828
*
2929
* @author Stephane Nicoll
3030
* @since 4.1

0 commit comments

Comments
 (0)