From d315bbaa1428b5f946cc1609d220121f8be642b9 Mon Sep 17 00:00:00 2001 From: Norman Maurer Date: Thu, 14 Aug 2014 06:43:22 +0200 Subject: [PATCH] Fix and clearify javadocs Motivation: ByteToMessageDecoder and ReplayingDecoder have incorrect javadocs in some places. Modifications: Fix incorrect javadocs for both classes. Result: Correct javadocs for both classes --- .../java/io/netty/handler/codec/ByteToMessageDecoder.java | 5 ++--- .../main/java/io/netty/handler/codec/ReplayingDecoder.java | 2 +- 2 files changed, 3 insertions(+), 4 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 7dc3a932e6..7512696609 100644 --- a/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java +++ b/codec/src/main/java/io/netty/handler/codec/ByteToMessageDecoder.java @@ -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 - * {@link ByteBuf} has nothing to read anymore, till nothing was read from the input {@link ByteBuf} or till - * this method returns {@code null}. + * {@link ByteBuf} has nothing to read when return from this method or till nothing was read from the input + * {@link ByteBuf}. * * @param ctx the {@link ChannelHandlerContext} which this {@link ByteToMessageDecoder} belongs to * @param in the {@link ByteBuf} from which to read data * @param out the {@link List} to which decoded messages should be added - * @throws Exception is thrown if an error accour */ protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List out) throws Exception; diff --git a/codec/src/main/java/io/netty/handler/codec/ReplayingDecoder.java b/codec/src/main/java/io/netty/handler/codec/ReplayingDecoder.java index fec1c782f4..bc583bcdf9 100644 --- a/codec/src/main/java/io/netty/handler/codec/ReplayingDecoder.java +++ b/codec/src/main/java/io/netty/handler/codec/ReplayingDecoder.java @@ -240,7 +240,7 @@ import java.util.List; * public class FirstDecoder extends {@link ReplayingDecoder}<{@link Void}> { * * {@code @Override} - * protected Object decode({@link ChannelHandlerContext} ctx, + * protected void decode({@link ChannelHandlerContext} ctx, * {@link ByteBuf} buf, List<Object> out) { * ... * // Decode the first message