Skip to content

Commit d1e6883

Browse files
committed
Fix issues in Javadoc
1 parent 5170f3f commit d1e6883

File tree

5 files changed

+20
-13
lines changed

5 files changed

+20
-13
lines changed

build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ configure([rootProject] + javaProjects) { project ->
380380
"https://fasterxml.github.io/jackson-databind/javadoc/2.10/",
381381
"https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.10/",
382382
"https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/",
383+
"https://projectreactor.io/docs/test/release/api/",
383384
"https://junit.org/junit4/javadoc/4.13.1/",
384385
"https://junit.org/junit5/docs/5.7.0/api/"
385386
] as String[]

spring-core/src/main/java/org/springframework/core/KotlinDetector.java

-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ public static boolean isKotlinType(Class<?> clazz) {
7777

7878
/**
7979
* Return {@code true} if the method is a suspending function.
80-
* @author Sebastien Deleuze
8180
* @since 5.3
8281
*/
8382
public static boolean isSuspendingFunction(Method method) {

spring-core/src/main/java/org/springframework/core/metrics/jfr/FlightRecorderApplicationStartup.java

+7-4
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,13 @@
2424

2525
/**
2626
* {@link ApplicationStartup} implementation for the Java Flight Recorder.
27-
* <p>This variant records {@link StartupStep} as Flight Recorder events; because such events
28-
* only support base types, the {@link StartupStep.Tags} are serialized as a single String attribute.
29-
* <p>Once this is configured on the application context, you can record data by launching the application
30-
* with recording enabled: {@code java -XX:StartFlightRecording:filename=recording.jfr,duration=10s -jar app.jar}.
27+
* <p>This variant records {@link StartupStep} as Flight Recorder events. Because
28+
* such events only support base types, the
29+
* {@link org.springframework.core.metrics.StartupStep.Tags} are serialized as a
30+
* single String attribute.
31+
* <p>Once this is configured on the application context, you can record data by
32+
* launching the application with recording enabled:
33+
* {@code java -XX:StartFlightRecording:filename=recording.jfr,duration=10s -jar app.jar}.
3134
*
3235
* @author Brian Clozel
3336
* @since 5.3

spring-webflux/src/main/java/org/springframework/web/reactive/socket/client/ReactorNettyWebSocketClient.java

+6-4
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public ReactorNettyWebSocketClient() {
6767

6868
/**
6969
* Constructor that accepts an existing {@link HttpClient} builder
70-
* with a default {@link WebsocketClientSpec.Builder}.
70+
* with a default {@link reactor.netty.http.client.WebsocketClientSpec.Builder}.
7171
* @since 5.1
7272
*/
7373
public ReactorNettyWebSocketClient(HttpClient httpClient) {
@@ -76,7 +76,7 @@ public ReactorNettyWebSocketClient(HttpClient httpClient) {
7676

7777
/**
7878
* Constructor that accepts an existing {@link HttpClient} builder
79-
* and a pre-configured {@link WebsocketClientSpec.Builder}.
79+
* and a pre-configured {@link reactor.netty.http.client.WebsocketClientSpec.Builder}.
8080
* @since 5.3
8181
*/
8282
public ReactorNettyWebSocketClient(
@@ -132,7 +132,8 @@ private WebsocketClientSpec buildSpec(@Nullable String protocols) {
132132
* @param maxFramePayloadLength the max length for frames.
133133
* @since 5.2
134134
* @deprecated as of 5.3 in favor of providing a supplier of
135-
* {@link WebsocketClientSpec.Builder} with a constructor argument.
135+
* {@link reactor.netty.http.client.WebsocketClientSpec.Builder} with a
136+
* constructor argument
136137
*/
137138
@Deprecated
138139
public void setMaxFramePayloadLength(int maxFramePayloadLength) {
@@ -160,7 +161,8 @@ public int getMaxFramePayloadLength() {
160161
* @param handlePing whether to let Ping frames through for handling
161162
* @since 5.2.4
162163
* @deprecated as of 5.3 in favor of providing a supplier of
163-
* {@link WebsocketClientSpec.Builder} with a constructor argument.
164+
* {@link reactor.netty.http.client.WebsocketClientSpec.Builder} with a
165+
* constructor argument
164166
*/
165167
@Deprecated
166168
public void setHandlePing(boolean handlePing) {

spring-webflux/src/main/java/org/springframework/web/reactive/socket/server/upgrade/ReactorNettyRequestUpgradeStrategy.java

+6-4
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
5353

5454

5555
/**
56-
* Create an instances with a default {@link WebsocketServerSpec.Builder}.
56+
* Create an instances with a default {@link reactor.netty.http.server.WebsocketServerSpec.Builder}.
5757
* @since 5.2.6
5858
*/
5959
public ReactorNettyRequestUpgradeStrategy() {
@@ -62,7 +62,7 @@ public ReactorNettyRequestUpgradeStrategy() {
6262

6363

6464
/**
65-
* Create an instance with a pre-configured {@link WebsocketServerSpec.Builder}
65+
* Create an instance with a pre-configured {@link reactor.netty.http.server.WebsocketServerSpec.Builder}
6666
* to use for WebSocket upgrades.
6767
* @since 5.2.6
6868
*/
@@ -108,7 +108,8 @@ WebsocketServerSpec buildSpec(@Nullable String subProtocol) {
108108
* @param maxFramePayloadLength the max length for frames.
109109
* @since 5.1
110110
* @deprecated as of 5.2.6 in favor of providing a supplier of
111-
* {@link WebsocketServerSpec.Builder} with a constructor argument.
111+
* {@link reactor.netty.http.server.WebsocketServerSpec.Builder} with a
112+
* constructor argument
112113
*/
113114
@Deprecated
114115
public void setMaxFramePayloadLength(Integer maxFramePayloadLength) {
@@ -136,7 +137,8 @@ public int getMaxFramePayloadLength() {
136137
* @param handlePing whether to let Ping frames through for handling
137138
* @since 5.2.4
138139
* @deprecated as of 5.2.6 in favor of providing a supplier of
139-
* {@link WebsocketServerSpec.Builder} with a constructor argument.
140+
* {@link reactor.netty.http.server.WebsocketServerSpec.Builder} with a
141+
* constructor argument
140142
*/
141143
@Deprecated
142144
public void setHandlePing(boolean handlePing) {

0 commit comments

Comments
 (0)