[chores] Add javadoc description

reactor-netty-core/src/main/java/reactor/netty/NettyOutbound.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -154,7 +154,7 @@ default NettyOutbound sendFile(Path file) {
 	 * <p>It will listens for any error on write and closes
 	 * on terminal signal (complete|error). If more than one publisher is attached
 	 * (multiple calls to send()) completion occurs after all publishers complete.</p>
-	 * <p></p>Note: Nesting any send* method is not supported.</p>
+	 * <p>Note: Nesting any send* method is not supported.</p>
 	 *
 	 * @param file the file Path
 	 * @param position where to start

reactor-netty-core/src/main/java/reactor/netty/channel/ContextAwareChannelMetricsHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import reactor.netty.Connection;
 import reactor.netty.ConnectionObserver;
 import reactor.util.annotation.Nullable;
+import reactor.util.context.ContextView;
 
 import java.net.SocketAddress;
 import java.time.Duration;
@@ -30,6 +31,8 @@
 import static reactor.netty.Metrics.SUCCESS;
 
 /**
+ * {@link AbstractChannelMetricsHandler} that propagates {@link ContextView}.
+ *
  * @author Violeta Georgieva
  * @since 1.0.8
  */

reactor-netty-core/src/main/java/reactor/netty/channel/FluxReceive.java

@@ -38,6 +38,8 @@
 import static reactor.netty.ReactorNetty.format;
 
 /**
+ * An inbound-traffic API delegating to an underlying {@link Channel}.
+ *
  * @author Stephane Maldini
  */
 final class FluxReceive extends Flux<Object> implements Subscription, Disposable {

reactor-netty-core/src/main/java/reactor/netty/channel/MonoSend.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,6 +30,8 @@
 import reactor.netty.ReactorNetty;
 
 /**
+ * An outbound-traffic API delegating to an underlying {@link Channel}.
+ *
  * @author Stephane Maldini
  */
 abstract class MonoSend<I, O> extends Mono<Void> {

reactor-netty-core/src/main/java/reactor/netty/resources/NewConnectionProvider.java

@@ -46,6 +46,8 @@
 import static reactor.netty.ReactorNetty.format;
 
 /**
+ * {@link ConnectionProvider} that always establishes a new connection.
+ *
  * @author Stephane Maldini
  * @author Violeta Georgieva
  */

reactor-netty-core/src/main/java/reactor/netty/tcp/SslProvider.java

@@ -88,6 +88,8 @@ public static SslProvider addHandlerConfigurator(
 	}
 
 	/**
+	 * Updates the {@link DefaultConfigurationType} used by this {@link SslProvider}.
+	 *
 	 * @deprecated as of 1.0.6. Prefer {@link SslProvider.SslContextSpec#sslContext(ProtocolSslContextSpec)},
 	 * where the default configuration is applied before any other custom configuration.
 	 * This will be removed in version 1.2.0.
@@ -305,6 +307,9 @@ public enum DefaultConfigurationType {
 	}
 
 	/**
+	 * Default configuration type that will be applied to the provided
+	 * {@link SslContextBuilder}.
+	 *
 	 * @deprecated as of 1.0.6. Prefer {@link SslProvider.SslContextSpec#sslContext(ProtocolSslContextSpec)},
 	 * where the default configuration is applied before any other custom configuration.
 	 * This will be removed in version 1.2.0.

reactor-netty-core/src/main/java/reactor/netty/transport/AddressResolverGroupMetrics.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,6 +37,8 @@
 import static reactor.netty.Metrics.SUCCESS;
 
 /**
+ * Metrics related to name resolution.
+ *
  * @author Violeta Georgieva
  */
 final class AddressResolverGroupMetrics<T extends SocketAddress> extends AddressResolverGroup<T> {

reactor-netty-core/src/main/java/reactor/netty/transport/ByteBufAllocatorMetrics.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 
 import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.Tags;
+import io.netty.buffer.ByteBuf;
 import io.netty.buffer.ByteBufAllocator;
 import io.netty.buffer.ByteBufAllocatorMetric;
 import io.netty.buffer.PooledByteBufAllocator;
@@ -42,6 +43,8 @@
 import static reactor.netty.Metrics.USED_HEAP_MEMORY;
 
 /**
+ * Metrics related to {@link ByteBuf}.
+ *
  * @author Violeta Georgieva
  * @since 0.9
  */

reactor-netty-core/src/main/java/reactor/netty/udp/UdpConnection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,8 @@
 import reactor.util.annotation.Nullable;
 
 /**
+ * Operations specific for UDP.
+ *
  * @author Stephane Maldini
  */
 interface UdpConnection {

reactor-netty-core/src/main/java/reactor/netty/udp/UdpOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,6 +34,8 @@
 import static reactor.netty.ReactorNetty.format;
 
 /**
+ * {@link UdpInbound} and {@link UdpOutbound} that apply to a {@link Connection}.
+ *
  * @author Stephane Maldini
  */
 final class UdpOperations extends ChannelOperations<UdpInbound, UdpOutbound>

reactor-netty-core/src/test/java/reactor/netty/ConnectionIdleTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
+ * This test class verifies connection idle handling.
+ *
  * @author Simon Baslé
  */
 class ConnectionIdleTest {

reactor-netty-core/src/test/java/reactor/netty/ConnectionTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,6 +37,8 @@
 import static reactor.netty.NettyPipeline.RIGHT;
 
 /**
+ * This test class verifies {@link Connection}.
+ *
  * @author Simon Baslé
  * @author Violeta Georgieva
  */

reactor-netty-core/src/test/java/reactor/netty/ReactorNettyTest.java

@@ -31,6 +31,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
+ * This test class verifies {@link ReactorNetty}.
+ *
  * @author Violeta Georgieva
  */
 class ReactorNettyTest {

reactor-netty-core/src/test/java/reactor/netty/channel/MonoSendManyTest.java

@@ -52,6 +52,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
+ * This test class verifies {@link MonoSendMany}.
+ *
  * @author Stephane Maldini
  */
 class MonoSendManyTest {

reactor-netty-core/src/test/java/reactor/netty/tcp/TcpClientTests.java

@@ -85,6 +85,8 @@
 import static org.assertj.core.api.Assumptions.assumeThat;
 
 /**
+ * This test class verifies {@link TcpClient}.
+ *
  * @author Stephane Maldini
  * @since 2.5
  */

reactor-netty-core/src/test/java/reactor/netty/tcp/TcpMetricsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -59,6 +59,8 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
+ * This test class verifies TCP metrics functionality.
+ *
  * @author Violeta Georgieva
  */
 class TcpMetricsTests {

reactor-netty-core/src/test/java/reactor/netty/tcp/TcpSecureMetricsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,8 @@
 import static reactor.netty.Metrics.URI;
 
 /**
+ * This test class verifies TCP metrics functionality.
+ *
  * @author Violeta Georgieva
  */
 class TcpSecureMetricsTests extends TcpMetricsTests {

reactor-netty-core/src/test/java/reactor/netty/tcp/TcpServerTests.java

@@ -92,6 +92,8 @@
 import static org.assertj.core.api.Assumptions.assumeThat;
 
 /**
+ * This test class verifies {@link TcpServer}.
+ *
  * @author Jon Brisbin
  * @author Stephane Maldini
  */

reactor-netty-core/src/test/java/reactor/netty/transport/ClientTransportTest.java

@@ -51,6 +51,8 @@
 import static org.junit.jupiter.api.condition.OS.WINDOWS;
 
 /**
+ * This test class verifies {@link ClientTransport}.
+ *
  * @author Violeta Georgieva
  */
 class ClientTransportTest {

reactor-netty-core/src/test/java/reactor/netty/transport/NameResolverProviderTest.java

@@ -50,6 +50,8 @@
 import static reactor.netty.transport.NameResolverProvider.Build.DEFAULT_QUERY_TIMEOUT;
 
 /**
+ * This test class verifies {@link NameResolverProvider}.
+ *
  * @author Violeta Georgieva
  */
 class NameResolverProviderTest {

reactor-netty-core/src/test/java/reactor/netty/transport/ServerTransportTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,8 @@
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 
 /**
+ * This test class verifies {@link ServerTransport}.
+ *
  * @author Violeta Georgieva
  */
 class ServerTransportTest {

reactor-netty-core/src/test/java/reactor/netty/transport/TransportTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,6 +35,8 @@
 import reactor.netty.resources.LoopResources;
 
 /**
+ * This test class verifies {@link Transport}.
+ *
  * @author Violeta Georgieva
  */
 class TransportTest {

reactor-netty-core/src/test/java/reactor/netty/udp/UdpMetricsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -53,6 +53,8 @@
 import static reactor.netty.Metrics.URI;
 
 /**
+ * This test class verifies UDP metrics functionality.
+ *
  * @author Violeta Georgieva
  */
 class UdpMetricsTests {

reactor-netty-core/src/test/java/reactor/netty/udp/UdpResourcesTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
+ * This test class verifies {@link UdpResources}.
+ *
  * @author Violeta Georgieva
  */
 class UdpResourcesTest {

reactor-netty-core/src/test/java/reactor/netty/udp/UdpServerTests.java

@@ -64,6 +64,8 @@
 import static org.assertj.core.api.Assertions.fail;
 
 /**
+ * This test class verifies {@link UdpServer}.
+ *
  * @author Jon Brisbin
  * @author Stephane Maldini
  */

reactor-netty-http/src/main/java/reactor/netty/http/client/AbstractHttpClientMetricsHandler.java

@@ -36,6 +36,8 @@
 import static reactor.netty.ReactorNetty.format;
 
 /**
+ * {@link ChannelDuplexHandler} for handling {@link HttpClient} metrics.
+ *
  * @author Violeta Georgieva
  * @since 1.0.8
  */

reactor-netty-http/src/main/java/reactor/netty/http/client/ContextAwareHttpClientMetricsHandler.java

@@ -17,12 +17,15 @@
 
 import io.netty.channel.ChannelHandlerContext;
 import reactor.util.annotation.Nullable;
+import reactor.util.context.ContextView;
 
 import java.net.SocketAddress;
 import java.time.Duration;
 import java.util.function.Function;
 
 /**
+ * {@link AbstractHttpClientMetricsHandler} that propagates {@link ContextView}.
+ *
  * @author Violeta Georgieva
  * @since 1.0.8
  */

reactor-netty-http/src/main/java/reactor/netty/http/client/Http2Pool.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -619,6 +619,8 @@ void pendingAcquireLimitReached(Borrower borrower, int maxPending) {
 	}
 
 	/**
+	 * Adds a new {@link Borrower} to the queue.
+	 *
 	 * @param borrower a new {@link Borrower} to add to the queue and later either serve or consider pending
 	 */
 	void pendingOffer(Borrower borrower) {