From 6d07264412d8524d73af2da4d5bb7d54532786c6 Mon Sep 17 00:00:00 2001 From: Marco Craveiro Date: Tue, 3 Feb 2015 19:54:48 +0000 Subject: [PATCH] Minor idiomatic changes to java docs --- .../java/io/netty/handler/codec/ByteToMessageDecoder.java | 4 ++-- .../main/java/io/netty/util/concurrent/EventExecutor.java | 4 ++-- .../java/io/netty/util/concurrent/EventExecutorGroup.java | 6 +++--- transport/src/main/java/io/netty/channel/EventLoop.java | 2 +- .../src/main/java/io/netty/channel/EventLoopGroup.java | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java b/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java index 7bbc2bb113..9d01abe985 100644 --- a/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java +++ b/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java @@ -52,9 +52,9 @@ import java.util.List; * If a custom frame decoder is required, then one needs to be careful when implementing * one with {@link ByteToMessageDecoder}. Ensure there are enough bytes in the buffer for a * complete frame by checking {@link ByteBuf#readableBytes()}. If there are not enough bytes - * for a complete frame, return without modify the reader index to allow more bytes to arrive. + * for a complete frame, return without modifying the reader index to allow more bytes to arrive. *

- * To check for complete frames without modify the reader index, use methods like {@link ByteBuf#getInt(int)}. + * To check for complete frames without modifying the reader index, use methods like {@link ByteBuf#getInt(int)}. * One MUST use the reader index when using methods like {@link ByteBuf#getInt(int)}. * For example calling in.getInt(0) is assuming the frame starts at the beginning of the buffer, which * is not always the case. Use in.getInt(in.readerIndex()) instead. diff --git a/common/src/main/java/io/netty/util/concurrent/EventExecutor.java b/common/src/main/java/io/netty/util/concurrent/EventExecutor.java index 96fb747987..c54fbeb3f0 100644 --- a/common/src/main/java/io/netty/util/concurrent/EventExecutor.java +++ b/common/src/main/java/io/netty/util/concurrent/EventExecutor.java @@ -20,8 +20,8 @@ import java.util.Set; /** * The {@link EventExecutor} is a special {@link EventExecutorGroup} which comes * with some handy methods to see if a {@link Thread} is executed in a event loop. - * Beside this it also extends the {@link EventExecutorGroup} to allow a generic way to - * access methods. + * Besides this, it also extends the {@link EventExecutorGroup} to allow for a generic + * way to access methods. * */ public interface EventExecutor extends EventExecutorGroup { diff --git a/common/src/main/java/io/netty/util/concurrent/EventExecutorGroup.java b/common/src/main/java/io/netty/util/concurrent/EventExecutorGroup.java index 5ee3e84060..0ca5c82e60 100644 --- a/common/src/main/java/io/netty/util/concurrent/EventExecutorGroup.java +++ b/common/src/main/java/io/netty/util/concurrent/EventExecutorGroup.java @@ -23,9 +23,9 @@ import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; /** - * The {@link EventExecutorGroup} is responsible to provide {@link EventExecutor}'s to use via its - * {@link #next()} method. Beside this it also is responsible to handle their live-cycle and allows - * to shut them down in a global fashion. + * The {@link EventExecutorGroup} is responsible for providing the {@link EventExecutor}'s to use + * via its {@link #next()} method. Besides this, it is also responsible for handling their + * life-cycle and allows shutting them down in a global fashion. * */ public interface EventExecutorGroup extends ScheduledExecutorService, Iterable { diff --git a/transport/src/main/java/io/netty/channel/EventLoop.java b/transport/src/main/java/io/netty/channel/EventLoop.java index a750a216fd..661b17b86f 100644 --- a/transport/src/main/java/io/netty/channel/EventLoop.java +++ b/transport/src/main/java/io/netty/channel/EventLoop.java @@ -18,7 +18,7 @@ package io.netty.channel; import io.netty.util.concurrent.EventExecutor; /** - * Will handle all the I/O-Operations for a {@link Channel} once it was registered. + * Will handle all the I/O operations for a {@link Channel} once registered. * * One {@link EventLoop} instance will usually handle more then one {@link Channel} but this may depend on * implementation details and internals. diff --git a/transport/src/main/java/io/netty/channel/EventLoopGroup.java b/transport/src/main/java/io/netty/channel/EventLoopGroup.java index ab2f362408..e2bf7c2c0a 100644 --- a/transport/src/main/java/io/netty/channel/EventLoopGroup.java +++ b/transport/src/main/java/io/netty/channel/EventLoopGroup.java @@ -18,7 +18,7 @@ package io.netty.channel; import io.netty.util.concurrent.EventExecutorGroup; /** - * Special {@link EventExecutorGroup} which allows to register {@link Channel}'s that get + * Special {@link EventExecutorGroup} which allows registering {@link Channel}s that get * processed for later selection during the event loop. * */