Skip to content

Commit 780e487

Browse files
violetaggvioletagg
committed
[chores] Javadoc style: first sentence should end with a period
1 parent 3110fa6 commit 780e487

File tree

117 files changed

+530
-529
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+530
-529
lines changed

‎reactor-netty-core/src/jarFileTest/java/reactor/netty/AbstractJarFileTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -24,7 +24,7 @@
2424
import static java.util.Collections.emptyMap;
2525

2626
/**
27-
* A helper class to access the content of a shaded JAR
27+
* A helper class to access the content of a shaded JAR.
2828
*/
2929
class AbstractJarFileTest {
3030

‎reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
public class ByteBufFlux extends FluxOperator<ByteBuf, ByteBuf> {
4949

5050
/**
51-
* Decorate as {@link ByteBufFlux}
51+
* Decorate as {@link ByteBufFlux}.
5252
*
5353
* @param source publisher to decorate
5454
*
@@ -59,7 +59,7 @@ public static ByteBufFlux fromInbound(Publisher<?> source) {
5959
}
6060

6161
/**
62-
* Decorate as {@link ByteBufFlux}
62+
* Decorate as {@link ByteBufFlux}.
6363
*
6464
* @param source publisher to decorate
6565
* @param allocator the channel {@link ByteBufAllocator}
@@ -73,7 +73,7 @@ public static ByteBufFlux fromInbound(Publisher<?> source, ByteBufAllocator allo
7373

7474

7575
/**
76-
* Decorate as {@link ByteBufFlux}
76+
* Decorate as {@link ByteBufFlux}.
7777
*
7878
* @param source publisher to decorate
7979
* @return a {@link ByteBufFlux}
@@ -83,7 +83,7 @@ public static ByteBufFlux fromString(Publisher<? extends String> source) {
8383
}
8484

8585
/**
86-
* Decorate as {@link ByteBufFlux}
86+
* Decorate as {@link ByteBufFlux}.
8787
*
8888
* @param source publisher to decorate
8989
* @param charset the encoding charset
@@ -105,7 +105,7 @@ public static ByteBufFlux fromString(Publisher<? extends String> source, Charset
105105
/**
106106
* Open a {@link java.nio.channels.FileChannel} from a path and stream
107107
* {@link ByteBuf} chunks with a default maximum size of 500K into
108-
* the returned {@link ByteBufFlux}
108+
* the returned {@link ByteBufFlux}.
109109
*
110110
* @param path the path to the resource to stream
111111
*
@@ -117,7 +117,7 @@ public static ByteBufFlux fromPath(Path path) {
117117

118118
/**
119119
* Open a {@link java.nio.channels.FileChannel} from a path and stream
120-
* {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux}
120+
* {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux}.
121121
*
122122
* @param path the path to the resource to stream
123123
* @param maxChunkSize the maximum per-item ByteBuf size
@@ -185,7 +185,7 @@ public static ByteBufFlux fromPath(Path path,
185185
}
186186

187187
/**
188-
* Convert to a {@link ByteBuffer} inbound {@link Flux}
188+
* Convert to a {@link ByteBuffer} inbound {@link Flux}.
189189
*
190190
* @return a {@link ByteBuffer} inbound {@link Flux}
191191
*/
@@ -201,7 +201,7 @@ public final Flux<ByteBuffer> asByteBuffer() {
201201
}
202202

203203
/**
204-
* Convert to a {@literal byte[]} inbound {@link Flux}
204+
* Convert to a {@literal byte[]} inbound {@link Flux}.
205205
*
206206
* @return a {@literal byte[]} inbound {@link Flux}
207207
*/
@@ -348,7 +348,7 @@ static ByteBufFlux maybeFuse(Flux<ByteBuf> source, ByteBufAllocator allocator) {
348348
}
349349

350350
/**
351-
* A channel object to {@link ByteBuf} transformer
351+
* A channel object to {@link ByteBuf} transformer.
352352
*/
353353
static final Function<Object, ByteBuf> bytebufExtractor = o -> {
354354
if (o instanceof ByteBuf) {

‎reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -42,7 +42,7 @@
4242
public class ByteBufMono extends MonoOperator<ByteBuf, ByteBuf> {
4343

4444
/**
45-
* a {@link ByteBuffer} inbound {@link Mono}
45+
* a {@link ByteBuffer} inbound {@link Mono}.
4646
*
4747
* @return a {@link ByteBuffer} inbound {@link Mono}
4848
*/
@@ -58,7 +58,7 @@ public final Mono<ByteBuffer> asByteBuffer() {
5858
}
5959

6060
/**
61-
* a {@literal byte[]} inbound {@link Mono}
61+
* a {@literal byte[]} inbound {@link Mono}.
6262
*
6363
* @return a {@literal byte[]} inbound {@link Mono}
6464
*/
@@ -76,7 +76,7 @@ public final Mono<byte[]> asByteArray() {
7676
}
7777

7878
/**
79-
* a {@link String} inbound {@link Mono}
79+
* a {@link String} inbound {@link Mono}.
8080
*
8181
* @return a {@link String} inbound {@link Mono}
8282
*/
@@ -85,7 +85,7 @@ public final Mono<String> asString() {
8585
}
8686

8787
/**
88-
* a {@link String} inbound {@link Mono}
88+
* a {@link String} inbound {@link Mono}.
8989
*
9090
* @param charset the decoding charset
9191
*
@@ -124,7 +124,7 @@ public final Mono<InputStream> asInputStream() {
124124
}
125125

126126
/**
127-
* Decorate as {@link ByteBufMono}
127+
* Decorate as {@link ByteBufMono}.
128128
*
129129
* @param source publisher to decorate
130130
* @return a {@link ByteBufMono}
@@ -134,7 +134,7 @@ public static ByteBufMono fromString(Publisher<? extends String> source) {
134134
}
135135

136136
/**
137-
* Decorate as {@link ByteBufMono}
137+
* Decorate as {@link ByteBufMono}.
138138
*
139139
* @param source publisher to decorate
140140
* @param charset the encoding charset

‎reactor-netty-core/src/main/java/reactor/netty/ChannelBindException.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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,14 +23,14 @@
2323
import reactor.util.annotation.Nullable;
2424

2525
/**
26-
* Represents a failing attempt to bind a local socket address
26+
* Represents a failing attempt to bind a local socket address.
2727
*
2828
* @author Stephane Maldini
2929
*/
3030
public class ChannelBindException extends RuntimeException {
3131

3232
/**
33-
* Build a {@link ChannelBindException}
33+
* Build a {@link ChannelBindException}.
3434
*
3535
* @param bindAddress the local address
3636
* @param cause the root cause
@@ -76,7 +76,7 @@ public synchronized Throwable fillInStackTrace() {
7676
}
7777

7878
/**
79-
* Return the configured binding host
79+
* Return the configured binding host.
8080
*
8181
* @return the configured binding host
8282
*/
@@ -85,7 +85,7 @@ public String localHost() {
8585
}
8686

8787
/**
88-
* Return the configured binding port
88+
* Return the configured binding port.
8989
*
9090
* @return the configured local binding port
9191
*/

‎reactor-netty-core/src/main/java/reactor/netty/ChannelPipelineConfigurer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -32,7 +32,7 @@
3232
public interface ChannelPipelineConfigurer {
3333

3434
/**
35-
* Return a noop configurer
35+
* Return a noop configurer.
3636
*
3737
* @return a noop configurer
3838
*/
@@ -50,7 +50,7 @@ static ChannelPipelineConfigurer emptyConfigurer() {
5050
void onChannelInit(ConnectionObserver connectionObserver, Channel channel, @Nullable SocketAddress remoteAddress);
5151

5252
/**
53-
* Chain together another {@link ChannelPipelineConfigurer}
53+
* Chain together another {@link ChannelPipelineConfigurer}.
5454
*
5555
* @param other the next {@link ChannelPipelineConfigurer}
5656
*

‎reactor-netty-core/src/main/java/reactor/netty/Connection.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -25,7 +25,7 @@
2525
import static java.util.Objects.requireNonNull;
2626

2727
/**
28-
* Hold contextual information for the underlying {@link Channel}
28+
* Hold contextual information for the underlying {@link Channel}.
2929
*
3030
* @author Stephane Maldini
3131
* @since 0.8
@@ -34,7 +34,7 @@
3434
public interface Connection extends DisposableChannel {
3535

3636
/**
37-
* Return an existing {@link Connection} wrapper or create a simple new one
37+
* Return an existing {@link Connection} wrapper or create a simple new one.
3838
*
3939
* @param channel channel to retrieve the connection reference from
4040
*
@@ -345,7 +345,7 @@ default boolean rebind(@Nullable Connection connection) {
345345
}
346346

347347
/**
348-
* Remove a named handler if present and return this context
348+
* Remove a named handler if present and return this context.
349349
*
350350
* @param name handler name
351351
*

‎reactor-netty-core/src/main/java/reactor/netty/ConnectionObserver.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -33,7 +33,7 @@
3333
public interface ConnectionObserver {
3434

3535
/**
36-
* Return a noop connection listener
36+
* Return a noop connection listener.
3737
*
3838
* @return a noop connection listener
3939
*/
@@ -42,7 +42,7 @@ static ConnectionObserver emptyListener() {
4242
}
4343

4444
/**
45-
* Connection listener {@link Context}
45+
* Connection listener {@link Context}.
4646
*
4747
* @return current {@link Context} or {@link Context#empty()}
4848
*/
@@ -63,15 +63,15 @@ default void onUncaughtException(Connection connection, Throwable error) {
6363
}
6464

6565
/**
66-
* React on connection state change (e.g. http request or response)
66+
* React on connection state change (e.g. http request or response).
6767
*
6868
* @param connection the connection reference
6969
* @param newState the new State
7070
*/
7171
void onStateChange(Connection connection, State newState);
7272

7373
/**
74-
* Chain together another {@link ConnectionObserver}
74+
* Chain together another {@link ConnectionObserver}.
7575
*
7676
* @param other the next {@link ConnectionObserver}
7777
*

‎reactor-netty-core/src/main/java/reactor/netty/DisposableChannel.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -29,7 +29,7 @@
2929

3030
/**
3131
* Holds contextual information for the underlying channel and provides
32-
* non-blocking resource disposing API
32+
* non-blocking resource disposing API.
3333
*
3434
* @author Stephane Maldini
3535
* @since 0.7
@@ -63,7 +63,7 @@ default SocketAddress address() {
6363
Channel channel();
6464

6565
/**
66-
* Releases or closes the underlying {@link Channel}
66+
* Releases or closes the underlying {@link Channel}.
6767
*/
6868
@Override
6969
@SuppressWarnings({"FutureReturnValueIgnored", "FunctionalInterfaceMethodChanged"})
@@ -107,7 +107,7 @@ default void disposeNow(Duration timeout) {
107107
}
108108

109109
/**
110-
* Returns a {@link CoreSubscriber} that will dispose on complete or error
110+
* Returns a {@link CoreSubscriber} that will dispose on complete or error.
111111
*/
112112
default CoreSubscriber<Void> disposeSubscriber() {
113113
return new ReactorNetty.ChannelDisposer(this);

‎reactor-netty-core/src/main/java/reactor/netty/DisposableServer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved.
2+
* Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved.
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.
@@ -19,7 +19,7 @@
1919
import java.net.SocketAddress;
2020

2121
/**
22-
* Holds contextual information for the underlying server
22+
* Holds contextual information for the underlying server.
2323
*
2424
* @author Stephane Maldini
2525
* @author Violeta Georgieva

0 commit comments

Comments
 (0)