Skip to content

Commit 9fd1d0c

Browse files
committed
Polish Javadoc
This commit also reverts the change to ASM's SymbolTable class. See gh-34679
1 parent 30fcaef commit 9fd1d0c

File tree

10 files changed

+48
-34
lines changed

10 files changed

+48
-34
lines changed

Diff for: spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2024 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-core/src/main/java/org/springframework/asm/SymbolTable.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1473,7 +1473,7 @@ private static final class LabelEntry {
14731473

14741474
/**
14751475
* Another entry (and so on recursively) having the same hash code (modulo the size of {@link
1476-
* SymbolTable#labelEntries}) as this one.
1476+
* SymbolTable#labelEntries}}) as this one.
14771477
*/
14781478
LabelEntry next;
14791479

Diff for: spring-core/src/main/java/org/springframework/util/ObjectUtils.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2024 the original author or authors.
2+
* Copyright 2002-2025 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.
@@ -410,10 +410,10 @@ public static int nullSafeHash(@Nullable Object... elements) {
410410
}
411411

412412
/**
413-
* Return a hash code for the given object; typically the value of
414-
* {@code Object#hashCode()}. If the object is an array,
415-
* this method will delegate to any of the {@code Arrays.hashCode}
416-
* methods. If the object is {@code null}, this method returns 0.
413+
* Return a hash code for the given object, typically the value of
414+
* {@link Object#hashCode()}. If the object is an array, this method
415+
* will delegate to one of the {@code Arrays.hashCode} methods. If
416+
* the object is {@code null}, this method returns {@code 0}.
417417
* @see Object#hashCode()
418418
* @see Arrays
419419
*/

Diff for: spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2024 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-jms/src/main/java/org/springframework/jms/support/converter/MessagingMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-jms/src/main/java/org/springframework/jms/support/converter/SmartMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2016 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-messaging/src/main/java/org/springframework/messaging/converter/AbstractMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-messaging/src/main/java/org/springframework/messaging/converter/SmartMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2017 the original author or authors.
2+
* Copyright 2002-2025 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.

Diff for: spring-web/src/main/java/org/springframework/http/server/observation/ServerHttpObservationDocumentation.java

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 the original author or authors.
2+
* Copyright 2002-2025 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.
@@ -23,9 +23,11 @@
2323
import io.micrometer.observation.docs.ObservationDocumentation;
2424

2525
/**
26-
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server observations
27-
* for Servlet-based web applications.
28-
* <p>This class is used by automated tools to document KeyValues attached to the HTTP server observations.
26+
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server
27+
* observations for Servlet-based web applications.
28+
*
29+
* <p>This class is used by automated tools to document KeyValues attached to the
30+
* HTTP server observations.
2931
*
3032
* @author Brian Clozel
3133
* @since 6.0
@@ -56,7 +58,8 @@ public KeyName[] getHighCardinalityKeyNames() {
5658
public enum LowCardinalityKeyNames implements KeyName {
5759

5860
/**
59-
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the request was not received properly.
61+
* Name of the HTTP request method or {@value KeyValue#NONE_VALUE} if the
62+
* request was not received properly.
6063
*/
6164
METHOD {
6265
@Override
@@ -67,7 +70,8 @@ public String asString() {
6770
},
6871

6972
/**
70-
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was created.
73+
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was
74+
* created.
7175
*/
7276
STATUS {
7377
@Override
@@ -77,9 +81,10 @@ public String asString() {
7781
},
7882

7983
/**
80-
* URI pattern for the matching handler if available, falling back to {@code REDIRECTION} for 3xx responses,
81-
* {@code NOT_FOUND} for 404 responses, {@code root} for requests with no path info,
82-
* and {@code UNKNOWN} for all other requests.
84+
* URI pattern for the matching handler if available, falling back to
85+
* {@code REDIRECTION} for 3xx responses, {@code NOT_FOUND} for 404
86+
* responses, {@code root} for requests with no path info, and
87+
* {@code UNKNOWN} for all other requests.
8388
*/
8489
URI {
8590
@Override
@@ -89,7 +94,8 @@ public String asString() {
8994
},
9095

9196
/**
92-
* Name of the exception thrown during the exchange, or {@value KeyValue#NONE_VALUE} if no exception happened.
97+
* Name of the exception thrown during the exchange, or
98+
* {@value KeyValue#NONE_VALUE} if no exception was thrown.
9399
*/
94100
EXCEPTION {
95101
@Override
@@ -113,7 +119,7 @@ public String asString() {
113119
public enum HighCardinalityKeyNames implements KeyName {
114120

115121
/**
116-
* HTTP request URI.
122+
* HTTP request URL.
117123
*/
118124
HTTP_URL {
119125
@Override
@@ -123,4 +129,5 @@ public String asString() {
123129
}
124130

125131
}
132+
126133
}

Diff for: spring-web/src/main/java/org/springframework/http/server/reactive/observation/ServerHttpObservationDocumentation.java

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 the original author or authors.
2+
* Copyright 2002-2025 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.
@@ -23,9 +23,11 @@
2323
import io.micrometer.observation.docs.ObservationDocumentation;
2424

2525
/**
26-
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server observations
27-
* for reactive web applications.
28-
* <p>This class is used by automated tools to document KeyValues attached to the HTTP server observations.
26+
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server
27+
* observations for reactive web applications.
28+
*
29+
* <p>This class is used by automated tools to document KeyValues attached to the
30+
* HTTP server observations.
2931
*
3032
* @author Brian Clozel
3133
* @since 6.0
@@ -56,7 +58,8 @@ public KeyName[] getHighCardinalityKeyNames() {
5658
public enum LowCardinalityKeyNames implements KeyName {
5759

5860
/**
59-
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the request was not received properly.
61+
* Name of the HTTP request method or {@value KeyValue#NONE_VALUE} if the
62+
* request was not received properly.
6063
*/
6164
METHOD {
6265
@Override
@@ -67,7 +70,8 @@ public String asString() {
6770
},
6871

6972
/**
70-
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was created.
73+
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was
74+
* created.
7175
*/
7276
STATUS {
7377
@Override
@@ -77,9 +81,10 @@ public String asString() {
7781
},
7882

7983
/**
80-
* URI pattern for the matching handler if available, falling back to {@code REDIRECTION} for 3xx responses,
81-
* {@code NOT_FOUND} for 404 responses, {@code root} for requests with no path info,
82-
* and {@code UNKNOWN} for all other requests.
84+
* URI pattern for the matching handler if available, falling back to
85+
* {@code REDIRECTION} for 3xx responses, {@code NOT_FOUND} for 404
86+
* responses, {@code root} for requests with no path info, and
87+
* {@code UNKNOWN} for all other requests.
8388
*/
8489
URI {
8590
@Override
@@ -89,7 +94,8 @@ public String asString() {
8994
},
9095

9196
/**
92-
* Name of the exception thrown during the exchange, or {@value KeyValue#NONE_VALUE} if no exception happened.
97+
* Name of the exception thrown during the exchange, or
98+
* {@value KeyValue#NONE_VALUE} if no exception was thrown.
9399
*/
94100
EXCEPTION {
95101
@Override
@@ -113,7 +119,7 @@ public String asString() {
113119
public enum HighCardinalityKeyNames implements KeyName {
114120

115121
/**
116-
* HTTP request URI.
122+
* HTTP request URL.
117123
*/
118124
HTTP_URL {
119125
@Override
@@ -123,4 +129,5 @@ public String asString() {
123129
}
124130

125131
}
132+
126133
}

0 commit comments

Comments
 (0)