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

Fix and clearify javadocs

Browse Source 
Motivation:

ByteToMessageDecoder and ReplayingDecoder have incorrect javadocs in some places.

Modifications:

Fix incorrect javadocs for both classes.

Result:

Correct javadocs for both classes
This commit is contained in:
Norman Maurer 2014-08-14 06:43:22 +02:00
parent 061d5bc261
commit d315bbaa14
2 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -283,13 +283,12 @@ public abstract class ByteToMessageDecoder extends ChannelInboundHandlerAdapter
/** /**
* Decode the from one {@link ByteBuf} to an other. This method will be called till either the input * Decode the from one {@link ByteBuf} to an other. This method will be called till either the input
* {@link ByteBuf} has nothing to read anymore, till nothing was read from the input {@link ByteBuf} or till * {@link ByteBuf} has nothing to read when return from this method or till nothing was read from the input
* this method returns {@code null}. * {@link ByteBuf}.
* *
* @param ctx the {@link ChannelHandlerContext} which this {@link ByteToMessageDecoder} belongs to * @param ctx the {@link ChannelHandlerContext} which this {@link ByteToMessageDecoder} belongs to
* @param in the {@link ByteBuf} from which to read data * @param in the {@link ByteBuf} from which to read data
* @param out the {@link List} to which decoded messages should be added * @param out the {@link List} to which decoded messages should be added
* @throws Exception is thrown if an error accour * @throws Exception is thrown if an error accour
*/ */
protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception; protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception;

2
codec/src/main/java/io/netty/handler/codec/ReplayingDecoder.java
View File

@ -240,7 +240,7 @@ import java.util.List;
* public class FirstDecoder extends {@link ReplayingDecoder}&lt;{@link Void}&gt; { * public class FirstDecoder extends {@link ReplayingDecoder}&lt;{@link Void}&gt; {
* *
* {@code @Override} * {@code @Override}
* protected Object decode({@link ChannelHandlerContext} ctx, * protected void decode({@link ChannelHandlerContext} ctx,
* {@link ByteBuf} buf, List&lt;Object&gt; out) { * {@link ByteBuf} buf, List&lt;Object&gt; out) {
* ... * ...
* // Decode the first message * // Decode the first message