Skip to content

Commit bfdc99a

Browse files
committed
Fix Javadoc errors
See gh-27480
1 parent 2567b20 commit bfdc99a

File tree

28 files changed

+120
-120
lines changed

28 files changed

+120
-120
lines changed

spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class BeanNameAutoProxyCreator extends AbstractAutoProxyCreator {
6161
* FactoryBean will get proxied. This default behavior applies as of Spring 2.0.
6262
* If you intend to proxy a FactoryBean instance itself (a rare use case, but
6363
* Spring 1.2's default behavior), specify the bean name of the FactoryBean
64-
* including the factory-bean prefix "&": e.g. "&myFactoryBean".
64+
* including the factory-bean prefix "&": e.g. "&myFactoryBean".
6565
* @see org.springframework.beans.factory.FactoryBean
6666
* @see org.springframework.beans.factory.BeanFactory#FACTORY_BEAN_PREFIX
6767
*/

spring-beans/src/main/java/org/springframework/beans/factory/groovy/GroovyBeanDefinitionReader.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@
7575
*
7676
* def reader = new GroovyBeanDefinitionReader(myApplicationContext)
7777
* reader.beans {
78-
* dataSource(BasicDataSource) { // <--- invokeMethod
78+
* dataSource(BasicDataSource) { // &lt;--- invokeMethod
7979
* driverClassName = "org.hsqldb.jdbcDriver"
8080
* url = "jdbc:hsqldb:mem:grailsDB"
81-
* username = "sa" // <-- setProperty
81+
* username = "sa" // &lt;-- setProperty
8282
* password = ""
8383
* settings = [mynew:"setting"]
8484
* }
8585
* sessionFactory(SessionFactory) {
86-
* dataSource = dataSource // <-- getProperty for retrieving references
86+
* dataSource = dataSource // &lt;-- getProperty for retrieving references
8787
* }
8888
* myService(MyService) {
89-
* nestedBean = { AnotherBean bean -> // <-- setProperty with closure for nested bean
89+
* nestedBean = { AnotherBean bean -&gt; // &lt;-- setProperty with closure for nested bean
9090
* dataSource = dataSource
9191
* }
9292
* }
@@ -113,7 +113,7 @@
113113
* dataSource = dataSource
114114
* }
115115
* myService(MyService) {
116-
* nestedBean = { AnotherBean bean ->
116+
* nestedBean = { AnotherBean bean -&gt;
117117
* dataSource = dataSource
118118
* }
119119
* }

spring-context/src/main/java/org/springframework/context/annotation/Configuration.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -129,7 +129,7 @@
129129
* &#064;Configuration
130130
* public class AppConfig {
131131
*
132-
* &#064Autowired Environment env;
132+
* &#064;Autowired Environment env;
133133
*
134134
* &#064;Bean
135135
* public MyBean myBean() {
@@ -149,7 +149,7 @@
149149
* &#064;PropertySource("classpath:/com/acme/app.properties")
150150
* public class AppConfig {
151151
*
152-
* &#064Inject Environment env;
152+
* &#064;Inject Environment env;
153153
*
154154
* &#064;Bean
155155
* public MyBean myBean() {
@@ -170,7 +170,7 @@
170170
* &#064;PropertySource("classpath:/com/acme/app.properties")
171171
* public class AppConfig {
172172
*
173-
* &#064Value("${bean.name}") String beanName;
173+
* &#064;Value("${bean.name}") String beanName;
174174
*
175175
* &#064;Bean
176176
* public MyBean myBean() {
@@ -297,7 +297,7 @@
297297
* &#064;ImportResource("classpath:/com/acme/database-config.xml")
298298
* public class AppConfig {
299299
*
300-
* &#064Inject DataSource dataSource; // from XML
300+
* &#064;Inject DataSource dataSource; // from XML
301301
*
302302
* &#064;Bean
303303
* public MyBean myBean() {

spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -98,7 +98,7 @@
9898
* &#064;EnableAspectJAutoProxy
9999
* public class AppConfig {
100100
*
101-
* // no explicit &#064Bean definitions required
101+
* // no explicit &#064;Bean definitions required
102102
* }</pre>
103103
*
104104
* <b>Note: {@code @EnableAspectJAutoProxy} applies to its local application context only,

spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -46,18 +46,18 @@
4646
*
4747
* def context = new GenericGroovyApplicationContext()
4848
* context.reader.beans {
49-
* dataSource(BasicDataSource) { // <--- invokeMethod
49+
* dataSource(BasicDataSource) { // &lt;--- invokeMethod
5050
* driverClassName = "org.hsqldb.jdbcDriver"
5151
* url = "jdbc:hsqldb:mem:grailsDB"
52-
* username = "sa" // <-- setProperty
52+
* username = "sa" // &lt;-- setProperty
5353
* password = ""
5454
* settings = [mynew:"setting"]
5555
* }
5656
* sessionFactory(SessionFactory) {
57-
* dataSource = dataSource // <-- getProperty for retrieving references
57+
* dataSource = dataSource // &lt;-- getProperty for retrieving references
5858
* }
5959
* myService(MyService) {
60-
* nestedBean = { AnotherBean bean -> // <-- setProperty with closure for nested bean
60+
* nestedBean = { AnotherBean bean -&gt; // &lt;-- setProperty with closure for nested bean
6161
* dataSource = dataSource
6262
* }
6363
* }
@@ -84,7 +84,7 @@
8484
* dataSource = dataSource
8585
* }
8686
* myService(MyService) {
87-
* nestedBean = { AnotherBean bean ->
87+
* nestedBean = { AnotherBean bean -&gt;
8888
* dataSource = dataSource
8989
* }
9090
* }

spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -229,7 +229,7 @@ protected MessageFormat resolveCode(String code, Locale locale) {
229229
* for a Locale, after merging all specified resource bundles.
230230
* Either fetches the holder from the cache or freshly loads it.
231231
* <p>Only used when caching resource bundle contents forever, i.e.
232-
* with cacheSeconds < 0. Therefore, merged properties are always
232+
* with cacheSeconds &lt; 0. Therefore, merged properties are always
233233
* cached forever.
234234
*/
235235
protected PropertiesHolder getMergedProperties(Locale locale) {

spring-context/src/main/java/org/springframework/format/support/DefaultFormattingConversionService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* as {@code DefaultConversionService} exposes its own
3838
* {@link DefaultConversionService#addDefaultConverters addDefaultConverters} method.
3939
*
40-
* <p>Automatically registers formatters for JSR-354 Money & Currency, JSR-310 Date-Time
40+
* <p>Automatically registers formatters for JSR-354 Money &amp; Currency, JSR-310 Date-Time
4141
* and/or Joda-Time 2.x, depending on the presence of the corresponding API on the classpath.
4242
*
4343
* @author Chris Beams
@@ -100,7 +100,7 @@ public DefaultFormattingConversionService(
100100

101101
/**
102102
* Add formatters appropriate for most environments: including number formatters,
103-
* JSR-354 Money & Currency formatters, JSR-310 Date-Time and/or Joda-Time formatters,
103+
* JSR-354 Money &amp; Currency formatters, JSR-310 Date-Time and/or Joda-Time formatters,
104104
* depending on the presence of the corresponding API on the classpath.
105105
* @param formatterRegistry the service to register default formatters with
106106
*/

spring-context/src/main/java/org/springframework/validation/Validator.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -33,7 +33,7 @@
3333
* wholly of whitespace), and that any password that is present is
3434
* at least {@code 'MINIMUM_PASSWORD_LENGTH'} characters in length.
3535
*
36-
* <pre class="code"> public class UserLoginValidator implements Validator {
36+
* <pre class="code">public class UserLoginValidator implements Validator {
3737
*
3838
* private static final int MINIMUM_PASSWORD_LENGTH = 6;
3939
*
@@ -46,7 +46,7 @@
4646
* ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password", "field.required");
4747
* UserLogin login = (UserLogin) target;
4848
* if (login.getPassword() != null
49-
* && login.getPassword().trim().length() < MINIMUM_PASSWORD_LENGTH) {
49+
* &amp;&amp; login.getPassword().trim().length() &lt; MINIMUM_PASSWORD_LENGTH) {
5050
* errors.rejectValue("password", "field.min.length",
5151
* new Object[]{Integer.valueOf(MINIMUM_PASSWORD_LENGTH)},
5252
* "The password must be at least [" + MINIMUM_PASSWORD_LENGTH + "] characters in length.");

spring-core/src/main/java/org/springframework/core/env/CommandLinePropertySource.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -110,7 +110,7 @@
110110
* evaluate true:
111111
*
112112
* <pre class="code">
113-
* CommandLinePropertySource<?> ps = ...
113+
* CommandLinePropertySource&lt;?&gt; ps = ...
114114
* assert ps.containsProperty("o1") == true;
115115
* assert ps.containsProperty("o2") == true;
116116
* assert ps.containsProperty("o3") == false;
@@ -149,7 +149,7 @@
149149
* will evaluate true:
150150
*
151151
* <pre class="code">
152-
* CommandLinePropertySource<?> ps = ...
152+
* CommandLinePropertySource&lt;?&gt; ps = ...
153153
* assert ps.containsProperty("o1") == true;
154154
* assert ps.containsProperty("o2") == true;
155155
* assert ps.containsProperty("nonOptionArgs") == true;

spring-core/src/main/java/org/springframework/core/env/JOptCommandLinePropertySource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -42,7 +42,7 @@
4242
* parser.accepts("option1");
4343
* parser.accepts("option2").withRequiredArg();
4444
* OptionSet options = parser.parse(args);
45-
* PropertySource<?> ps = new JOptCommandLinePropertySource(options);
45+
* PropertySource&lt;?&gt; ps = new JOptCommandLinePropertySource(options);
4646
* // ...
4747
* }</pre>
4848
*

spring-core/src/main/java/org/springframework/core/env/SimpleCommandLinePropertySource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -66,7 +66,7 @@
6666
* <h3>Typical usage</h3>
6767
* <pre class="code">
6868
* public static void main(String[] args) {
69-
* PropertySource<?> ps = new SimpleCommandLinePropertySource(args);
69+
* PropertySource&lt;?&gt; ps = new SimpleCommandLinePropertySource(args);
7070
* // ...
7171
* }</pre>
7272
*

spring-jms/src/main/java/org/springframework/jms/annotation/EnableJms.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -138,7 +138,7 @@
138138
* }
139139
*
140140
* &#064;Bean
141-
* public JmsListenerContainerFactory<?> myJmsListenerContainerFactory() {
141+
* public JmsListenerContainerFactory&lt;?&gt; myJmsListenerContainerFactory() {
142142
* // factory settings
143143
* }
144144
*
@@ -184,7 +184,7 @@
184184
* }
185185
*
186186
* &#064;Bean
187-
* public JmsListenerEndpointRegistry<?> myJmsListenerEndpointRegistry() {
187+
* public JmsListenerEndpointRegistry&lt;?&gt; myJmsListenerEndpointRegistry() {
188188
* // registry configuration
189189
* }
190190
*
@@ -246,7 +246,7 @@
246246
* }
247247
*
248248
* &#064;Bean
249-
* public JmsListenerContainerFactory<?> anotherJmsListenerContainerFactory() {
249+
* public JmsListenerContainerFactory&lt;?&gt; anotherJmsListenerContainerFactory() {
250250
* // ...
251251
* }
252252
*

spring-messaging/src/main/java/org/springframework/messaging/handler/AbstractMessageCondition.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -67,7 +67,7 @@ public String toString() {
6767

6868
/**
6969
* The notation to use when printing discrete items of content.
70-
* For example " || " for URL patterns or " && " for param expressions.
70+
* For example " || " for URL patterns or " &amp;&amp; " for param expressions.
7171
*/
7272
protected abstract String getToStringInfix();
7373

spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateOperations.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 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.
@@ -606,7 +606,7 @@ public interface HibernateOperations {
606606
* @param firstResult the index of the first result object to be retrieved
607607
* (numbered from 0)
608608
* @param maxResults the maximum number of result objects to retrieve
609-
* (or <=0 for no limit)
609+
* (or &lt;=0 for no limit)
610610
* @return a {@link List} containing 0 or more persistent instances
611611
* @throws DataAccessException in case of Hibernate errors
612612
* @see DetachedCriteria#getExecutableCriteria(org.hibernate.Session)
@@ -643,7 +643,7 @@ public interface HibernateOperations {
643643
* @param firstResult the index of the first result object to be retrieved
644644
* (numbered from 0)
645645
* @param maxResults the maximum number of result objects to retrieve
646-
* (or <=0 for no limit)
646+
* (or &lt;=0 for no limit)
647647
* @return a {@link List} containing 0 or more persistent instances
648648
* @throws DataAccessException in case of Hibernate errors
649649
* @see org.hibernate.criterion.Example#create(Object)
@@ -660,7 +660,7 @@ public interface HibernateOperations {
660660
* @param firstResult the index of the first result object to be retrieved
661661
* (numbered from 0)
662662
* @param maxResults the maximum number of result objects to retrieve
663-
* (or <=0 for no limit)
663+
* (or &lt;=0 for no limit)
664664
* @return a {@link List} containing 0 or more persistent instances
665665
* @throws DataAccessException in case of Hibernate errors
666666
* @see org.hibernate.criterion.Example#create(Object)

spring-web/src/main/java/org/springframework/http/HttpStatus.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,21 +285,21 @@ public enum HttpStatus {
285285
I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"),
286286
/**
287287
* @deprecated See
288-
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">
288+
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
289289
* WebDAV Draft Changes</a>
290290
*/
291291
@Deprecated
292292
INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"),
293293
/**
294294
* @deprecated See
295-
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">
295+
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
296296
* WebDAV Draft Changes</a>
297297
*/
298298
@Deprecated
299299
METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"),
300300
/**
301301
* @deprecated
302-
* See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">
302+
* See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
303303
* WebDAV Draft Changes</a>
304304
*/
305305
@Deprecated

spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
* <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>:
8484
* support for other Java 8 types like {@link java.util.Optional}</li>
8585
* <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>:
86-
* support for Java 8 Date & Time API types</li>
86+
* support for Java 8 Date &amp; Time API types</li>
8787
* <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>:
8888
* support for Joda-Time types</li>
8989
* <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>:

0 commit comments

Comments
 (0)