Fix issues in Javadoc

This commit is contained in:
Sam Brannen 2020-10-27 11:05:31 +01:00
parent 5170f3f594
commit d1e6883d5d
5 changed files with 20 additions and 13 deletions

View File

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

View File

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

View File

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

View File

@ -67,7 +67,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/** /**
* Constructor that accepts an existing {@link HttpClient} builder * 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 * @since 5.1
*/ */
public ReactorNettyWebSocketClient(HttpClient httpClient) { public ReactorNettyWebSocketClient(HttpClient httpClient) {
@ -76,7 +76,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/** /**
* Constructor that accepts an existing {@link HttpClient} builder * 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 * @since 5.3
*/ */
public ReactorNettyWebSocketClient( public ReactorNettyWebSocketClient(
@ -132,7 +132,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* @param maxFramePayloadLength the max length for frames. * @param maxFramePayloadLength the max length for frames.
* @since 5.2 * @since 5.2
* @deprecated as of 5.3 in favor of providing a supplier of * @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 @Deprecated
public void setMaxFramePayloadLength(int maxFramePayloadLength) { public void setMaxFramePayloadLength(int maxFramePayloadLength) {
@ -160,7 +161,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* @param handlePing whether to let Ping frames through for handling * @param handlePing whether to let Ping frames through for handling
* @since 5.2.4 * @since 5.2.4
* @deprecated as of 5.3 in favor of providing a supplier of * @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 @Deprecated
public void setHandlePing(boolean handlePing) { public void setHandlePing(boolean handlePing) {

View File

@ -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 * @since 5.2.6
*/ */
public ReactorNettyRequestUpgradeStrategy() { public ReactorNettyRequestUpgradeStrategy() {
@ -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. * to use for WebSocket upgrades.
* @since 5.2.6 * @since 5.2.6
*/ */
@ -108,7 +108,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param maxFramePayloadLength the max length for frames. * @param maxFramePayloadLength the max length for frames.
* @since 5.1 * @since 5.1
* @deprecated as of 5.2.6 in favor of providing a supplier of * @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 @Deprecated
public void setMaxFramePayloadLength(Integer maxFramePayloadLength) { public void setMaxFramePayloadLength(Integer maxFramePayloadLength) {
@ -136,7 +137,8 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param handlePing whether to let Ping frames through for handling * @param handlePing whether to let Ping frames through for handling
* @since 5.2.4 * @since 5.2.4
* @deprecated as of 5.2.6 in favor of providing a supplier of * @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 @Deprecated
public void setHandlePing(boolean handlePing) { public void setHandlePing(boolean handlePing) {