andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor idiomatic changes to java docs

Browse Source
This commit is contained in:
Marco Craveiro 2015-02-03 19:54:48 +00:00 committed by Norman Maurer
parent 86cb41bf95
commit 6d07264412
5 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java
View File

@ -52,9 +52,9 @@ import java.util.List;
* If a custom frame decoder is required, then one needs to be careful when implementing * 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 * 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 * 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.
* <p> * <p>
* 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 <strong>MUST</strong> use the reader index when using methods like {@link ByteBuf#getInt(int)}. * One <strong>MUST</strong> use the reader index when using methods like {@link ByteBuf#getInt(int)}.
* For example calling <tt>in.getInt(0)</tt> is assuming the frame starts at the beginning of the buffer, which * For example calling <tt>in.getInt(0)</tt> is assuming the frame starts at the beginning of the buffer, which
* is not always the case. Use <tt>in.getInt(in.readerIndex())</tt> instead. * is not always the case. Use <tt>in.getInt(in.readerIndex())</tt> instead.

4
common/src/main/java/io/netty/util/concurrent/EventExecutor.java
View File

@ -20,8 +20,8 @@ import java.util.Set;
/** /**
* The {@link EventExecutor} is a special {@link EventExecutorGroup} which comes * 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. * 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 * Besides this, it also extends the {@link EventExecutorGroup} to allow for a generic
* access methods. * way to access methods.
* *
*/ */
public interface EventExecutor extends EventExecutorGroup { public interface EventExecutor extends EventExecutorGroup {

6
common/src/main/java/io/netty/util/concurrent/EventExecutorGroup.java
View File

@ -23,9 +23,9 @@ import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
/** /**
* The {@link EventExecutorGroup} is responsible to provide {@link EventExecutor}'s to use via its * The {@link EventExecutorGroup} is responsible for providing the {@link EventExecutor}'s to use
* {@link #next()} method. Beside this it also is responsible to handle their live-cycle and allows * via its {@link #next()} method. Besides this, it is also responsible for handling their
* to shut them down in a global fashion. * life-cycle and allows shutting them down in a global fashion.
* *
*/ */
public interface EventExecutorGroup extends ScheduledExecutorService, Iterable<EventExecutor> { public interface EventExecutorGroup extends ScheduledExecutorService, Iterable<EventExecutor> {

2
transport/src/main/java/io/netty/channel/EventLoop.java
View File

@ -18,7 +18,7 @@ package io.netty.channel;
import io.netty.util.concurrent.EventExecutor; 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 * One {@link EventLoop} instance will usually handle more then one {@link Channel} but this may depend on
* implementation details and internals. * implementation details and internals.

2
transport/src/main/java/io/netty/channel/EventLoopGroup.java
View File

@ -18,7 +18,7 @@ package io.netty.channel;
import io.netty.util.concurrent.EventExecutorGroup; 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. * processed for later selection during the event loop.
* *
*/ */