Browse Source

Fix issues in Javadoc

pull/25991/head
Sam Brannen 4 years ago
parent
commit
d1e6883d5d
  1. 1
      build.gradle
  2. 1
      spring-core/src/main/java/org/springframework/core/KotlinDetector.java
  3. 11
      spring-core/src/main/java/org/springframework/core/metrics/jfr/FlightRecorderApplicationStartup.java
  4. 10
      spring-webflux/src/main/java/org/springframework/web/reactive/socket/client/ReactorNettyWebSocketClient.java
  5. 10
      spring-webflux/src/main/java/org/springframework/web/reactive/socket/server/upgrade/ReactorNettyRequestUpgradeStrategy.java

1
build.gradle

@ -380,6 +380,7 @@ configure([rootProject] + javaProjects) { project -> @@ -380,6 +380,7 @@ configure([rootProject] + javaProjects) { project ->
"https://fasterxml.github.io/jackson-databind/javadoc/2.10/",
"https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.10/",
"https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/",
"https://projectreactor.io/docs/test/release/api/",
"https://junit.org/junit4/javadoc/4.13.1/",
"https://junit.org/junit5/docs/5.7.0/api/"
] as String[]

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

@ -77,7 +77,6 @@ public abstract class KotlinDetector { @@ -77,7 +77,6 @@ public abstract class KotlinDetector {
/**
* Return {@code true} if the method is a suspending function.
* @author Sebastien Deleuze
* @since 5.3
*/
public static boolean isSuspendingFunction(Method method) {

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

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

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

@ -67,7 +67,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient { @@ -67,7 +67,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/**
* Constructor that accepts an existing {@link HttpClient} builder
* with a default {@link WebsocketClientSpec.Builder}.
* with a default {@link reactor.netty.http.client.WebsocketClientSpec.Builder}.
* @since 5.1
*/
public ReactorNettyWebSocketClient(HttpClient httpClient) {
@ -76,7 +76,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient { @@ -76,7 +76,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/**
* Constructor that accepts an existing {@link HttpClient} builder
* and a pre-configured {@link WebsocketClientSpec.Builder}.
* and a pre-configured {@link reactor.netty.http.client.WebsocketClientSpec.Builder}.
* @since 5.3
*/
public ReactorNettyWebSocketClient(
@ -132,7 +132,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient { @@ -132,7 +132,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* @param maxFramePayloadLength the max length for frames.
* @since 5.2
* @deprecated as of 5.3 in favor of providing a supplier of
* {@link WebsocketClientSpec.Builder} with a constructor argument.
* {@link reactor.netty.http.client.WebsocketClientSpec.Builder} with a
* constructor argument
*/
@Deprecated
public void setMaxFramePayloadLength(int maxFramePayloadLength) {
@ -160,7 +161,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient { @@ -160,7 +161,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* @param handlePing whether to let Ping frames through for handling
* @since 5.2.4
* @deprecated as of 5.3 in favor of providing a supplier of
* {@link WebsocketClientSpec.Builder} with a constructor argument.
* {@link reactor.netty.http.client.WebsocketClientSpec.Builder} with a
* constructor argument
*/
@Deprecated
public void setHandlePing(boolean handlePing) {

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

@ -53,7 +53,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg @@ -53,7 +53,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
/**
* Create an instances with a default {@link WebsocketServerSpec.Builder}.
* Create an instances with a default {@link reactor.netty.http.server.WebsocketServerSpec.Builder}.
* @since 5.2.6
*/
public ReactorNettyRequestUpgradeStrategy() {
@ -62,7 +62,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg @@ -62,7 +62,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
/**
* Create an instance with a pre-configured {@link WebsocketServerSpec.Builder}
* Create an instance with a pre-configured {@link reactor.netty.http.server.WebsocketServerSpec.Builder}
* to use for WebSocket upgrades.
* @since 5.2.6
*/
@ -108,7 +108,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg @@ -108,7 +108,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param maxFramePayloadLength the max length for frames.
* @since 5.1
* @deprecated as of 5.2.6 in favor of providing a supplier of
* {@link WebsocketServerSpec.Builder} with a constructor argument.
* {@link reactor.netty.http.server.WebsocketServerSpec.Builder} with a
* constructor argument
*/
@Deprecated
public void setMaxFramePayloadLength(Integer maxFramePayloadLength) {
@ -136,7 +137,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg @@ -136,7 +137,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param handlePing whether to let Ping frames through for handling
* @since 5.2.4
* @deprecated as of 5.2.6 in favor of providing a supplier of
* {@link WebsocketServerSpec.Builder} with a constructor argument.
* {@link reactor.netty.http.server.WebsocketServerSpec.Builder} with a
* constructor argument
*/
@Deprecated
public void setHandlePing(boolean handlePing) {

Loading…
Cancel
Save