Skip to content

Commit

Permalink
[chores] Javadoc style: first sentence should end with a period
Browse files Browse the repository at this point in the history
  • Loading branch information
violetagg committed Nov 13, 2023
1 parent 3110fa6 commit 780e487
Show file tree
Hide file tree
Showing 117 changed files with 530 additions and 529 deletions.
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -24,7 +24,7 @@
import static java.util.Collections.emptyMap;

/**
* A helper class to access the content of a shaded JAR
* A helper class to access the content of a shaded JAR.
*/
class AbstractJarFileTest {

Expand Down
18 changes: 9 additions & 9 deletions reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
public class ByteBufFlux extends FluxOperator<ByteBuf, ByteBuf> {

/**
* Decorate as {@link ByteBufFlux}
* Decorate as {@link ByteBufFlux}.
*
* @param source publisher to decorate
*
Expand All @@ -59,7 +59,7 @@ public static ByteBufFlux fromInbound(Publisher<?> source) {
}

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


/**
* Decorate as {@link ByteBufFlux}
* Decorate as {@link ByteBufFlux}.
*
* @param source publisher to decorate
* @return a {@link ByteBufFlux}
Expand All @@ -83,7 +83,7 @@ public static ByteBufFlux fromString(Publisher<? extends String> source) {
}

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

/**
* Open a {@link java.nio.channels.FileChannel} from a path and stream
* {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux}
* {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux}.
*
* @param path the path to the resource to stream
* @param maxChunkSize the maximum per-item ByteBuf size
Expand Down Expand Up @@ -185,7 +185,7 @@ public static ByteBufFlux fromPath(Path path,
}

/**
* Convert to a {@link ByteBuffer} inbound {@link Flux}
* Convert to a {@link ByteBuffer} inbound {@link Flux}.
*
* @return a {@link ByteBuffer} inbound {@link Flux}
*/
Expand All @@ -201,7 +201,7 @@ public final Flux<ByteBuffer> asByteBuffer() {
}

/**
* Convert to a {@literal byte[]} inbound {@link Flux}
* Convert to a {@literal byte[]} inbound {@link Flux}.
*
* @return a {@literal byte[]} inbound {@link Flux}
*/
Expand Down Expand Up @@ -348,7 +348,7 @@ static ByteBufFlux maybeFuse(Flux<ByteBuf> source, ByteBufAllocator allocator) {
}

/**
* A channel object to {@link ByteBuf} transformer
* A channel object to {@link ByteBuf} transformer.
*/
static final Function<Object, ByteBuf> bytebufExtractor = o -> {
if (o instanceof ByteBuf) {
Expand Down
14 changes: 7 additions & 7 deletions reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -42,7 +42,7 @@
public class ByteBufMono extends MonoOperator<ByteBuf, ByteBuf> {

/**
* a {@link ByteBuffer} inbound {@link Mono}
* a {@link ByteBuffer} inbound {@link Mono}.
*
* @return a {@link ByteBuffer} inbound {@link Mono}
*/
Expand All @@ -58,7 +58,7 @@ public final Mono<ByteBuffer> asByteBuffer() {
}

/**
* a {@literal byte[]} inbound {@link Mono}
* a {@literal byte[]} inbound {@link Mono}.
*
* @return a {@literal byte[]} inbound {@link Mono}
*/
Expand All @@ -76,7 +76,7 @@ public final Mono<byte[]> asByteArray() {
}

/**
* a {@link String} inbound {@link Mono}
* a {@link String} inbound {@link Mono}.
*
* @return a {@link String} inbound {@link Mono}
*/
Expand All @@ -85,7 +85,7 @@ public final Mono<String> asString() {
}

/**
* a {@link String} inbound {@link Mono}
* a {@link String} inbound {@link Mono}.
*
* @param charset the decoding charset
*
Expand Down Expand Up @@ -124,7 +124,7 @@ public final Mono<InputStream> asInputStream() {
}

/**
* Decorate as {@link ByteBufMono}
* Decorate as {@link ByteBufMono}.
*
* @param source publisher to decorate
* @return a {@link ByteBufMono}
Expand All @@ -134,7 +134,7 @@ public static ByteBufMono fromString(Publisher<? extends String> source) {
}

/**
* Decorate as {@link ByteBufMono}
* Decorate as {@link ByteBufMono}.
*
* @param source publisher to decorate
* @param charset the encoding charset
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved.
* Copyright (c) 2018-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.
Expand All @@ -23,14 +23,14 @@
import reactor.util.annotation.Nullable;

/**
* Represents a failing attempt to bind a local socket address
* Represents a failing attempt to bind a local socket address.
*
* @author Stephane Maldini
*/
public class ChannelBindException extends RuntimeException {

/**
* Build a {@link ChannelBindException}
* Build a {@link ChannelBindException}.
*
* @param bindAddress the local address
* @param cause the root cause
Expand Down Expand Up @@ -76,7 +76,7 @@ public synchronized Throwable fillInStackTrace() {
}

/**
* Return the configured binding host
* Return the configured binding host.
*
* @return the configured binding host
*/
Expand All @@ -85,7 +85,7 @@ public String localHost() {
}

/**
* Return the configured binding port
* Return the configured binding port.
*
* @return the configured local binding port
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -32,7 +32,7 @@
public interface ChannelPipelineConfigurer {

/**
* Return a noop configurer
* Return a noop configurer.
*
* @return a noop configurer
*/
Expand All @@ -50,7 +50,7 @@ static ChannelPipelineConfigurer emptyConfigurer() {
void onChannelInit(ConnectionObserver connectionObserver, Channel channel, @Nullable SocketAddress remoteAddress);

/**
* Chain together another {@link ChannelPipelineConfigurer}
* Chain together another {@link ChannelPipelineConfigurer}.
*
* @param other the next {@link ChannelPipelineConfigurer}
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011-2022 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.
Expand All @@ -25,7 +25,7 @@
import static java.util.Objects.requireNonNull;

/**
* Hold contextual information for the underlying {@link Channel}
* Hold contextual information for the underlying {@link Channel}.
*
* @author Stephane Maldini
* @since 0.8
Expand All @@ -34,7 +34,7 @@
public interface Connection extends DisposableChannel {

/**
* Return an existing {@link Connection} wrapper or create a simple new one
* Return an existing {@link Connection} wrapper or create a simple new one.
*
* @param channel channel to retrieve the connection reference from
*
Expand Down Expand Up @@ -345,7 +345,7 @@ default boolean rebind(@Nullable Connection connection) {
}

/**
* Remove a named handler if present and return this context
* Remove a named handler if present and return this context.
*
* @param name handler name
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved.
* Copyright (c) 2018-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.
Expand Down Expand Up @@ -33,7 +33,7 @@
public interface ConnectionObserver {

/**
* Return a noop connection listener
* Return a noop connection listener.
*
* @return a noop connection listener
*/
Expand All @@ -42,7 +42,7 @@ static ConnectionObserver emptyListener() {
}

/**
* Connection listener {@link Context}
* Connection listener {@link Context}.
*
* @return current {@link Context} or {@link Context#empty()}
*/
Expand All @@ -63,15 +63,15 @@ default void onUncaughtException(Connection connection, Throwable error) {
}

/**
* React on connection state change (e.g. http request or response)
* React on connection state change (e.g. http request or response).
*
* @param connection the connection reference
* @param newState the new State
*/
void onStateChange(Connection connection, State newState);

/**
* Chain together another {@link ConnectionObserver}
* Chain together another {@link ConnectionObserver}.
*
* @param other the next {@link ConnectionObserver}
*
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -29,7 +29,7 @@

/**
* Holds contextual information for the underlying channel and provides
* non-blocking resource disposing API
* non-blocking resource disposing API.
*
* @author Stephane Maldini
* @since 0.7
Expand Down Expand Up @@ -63,7 +63,7 @@ default SocketAddress address() {
Channel channel();

/**
* Releases or closes the underlying {@link Channel}
* Releases or closes the underlying {@link Channel}.
*/
@Override
@SuppressWarnings({"FutureReturnValueIgnored", "FunctionalInterfaceMethodChanged"})
Expand Down Expand Up @@ -107,7 +107,7 @@ default void disposeNow(Duration timeout) {
}

/**
* Returns a {@link CoreSubscriber} that will dispose on complete or error
* Returns a {@link CoreSubscriber} that will dispose on complete or error.
*/
default CoreSubscriber<Void> disposeSubscriber() {
return new ReactorNetty.ChannelDisposer(this);
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -19,7 +19,7 @@
import java.net.SocketAddress;

/**
* Holds contextual information for the underlying server
* Holds contextual information for the underlying server.
*
* @author Stephane Maldini
* @author Violeta Georgieva
Expand Down

0 comments on commit 780e487

Please sign in to comment.