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

Fix javadoc warnings

Browse Source
This commit is contained in:
norman 2012-07-05 10:42:26 +02:00
parent e0f139c5d7
commit b089f0c59b
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/org/jboss/netty/buffer/CompositeChannelBuffer.java
View File

@ -572,7 +572,7 @@ public class CompositeChannelBuffer extends AbstractChannelBuffer {
*
*
* @param index The {@code index} to search for and include in the returned {@link ByteBuf}
* @return The {@link ByteBuf} that contains the specified {@code index}
* @return The {@link ChannelBuffer} that contains the specified {@code index}
* @throws IndexOutOfBoundsException when the specified {@code index} is
* less than zero, or larger than {@code capacity()}
*/

13
src/main/java/org/jboss/netty/handler/traffic/package-info.java
View File

@ -37,10 +37,12 @@
* Channel traffic shaping and Global traffic shaping.</li><br><br>
*
* The insertion in the pipeline of one of those handlers can be wherever you want, but
* <b>it must be placed before any <tt>{@link MemoryAwareThreadPoolExecutor}</tt>
* <b>it must be placed before any <tt>{@link org.jboss.netty.handler.execution.MemoryAwareThreadPoolExecutor}</tt>
* in your pipeline</b>.<br>
* <b><i>It is really recommended to have such a</i> <tt>{@link MemoryAwareThreadPoolExecutor}</tt>
* <i>(either non ordered or </i> <tt>{@link OrderedMemoryAwareThreadPoolExecutor}</tt>
* <b><i>It is really recommended to have such a</i>
* <tt>{@link org.jboss.netty.handler.execution.MemoryAwareThreadPoolExecutor}</tt>
* <i>(either non ordered or </i>
* <tt>{@link org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor}</tt>
* <i>) in your pipeline</i></b>
* when you want to use this feature with some real traffic shaping, since it will allow to relax the constraint on
* NioWorker to do other jobs if necessary.<br>
@ -52,9 +54,10 @@
* 60KB/s for each channel since NioWorkers are stopping by this handler.<br>
* When it is used as a read traffic shaper, the handler will set the channel as not readable, so as to relax the
* NioWorkers.<br><br>
* An {@link ObjectSizeEstimator} can be passed at construction to specify what
* An {@link org.jboss.netty.util.ObjectSizeEstimator} can be passed at construction to specify what
* is the size of the object to be read or write accordingly to the type of
* object. If not specified, it will used the {@link DefaultObjectSizeEstimator} implementation.<br><br>
* object. If not specified, it will used the {@link org.jboss.netty.util.DefaultObjectSizeEstimator}
* implementation.<br><br>
* </ul></P>
*
* <P>Standard use could be as follow:</P>