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

Minor corrections to Http2 example javadocs.

Browse Source 
Motivation:
There are a few very minor issues in the Http2 examples javadoc and
since I don't think that these javadocs are published this is very much
optional to include.

Modifications:
Updated the @see according to [1] to avoid warning when generating
javadocs.

Result:
No warning when generating javadocs.

[1] http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see
This commit is contained in:
Daniel Bevenius 2014-11-06 09:15:37 +01:00 committed by Norman Maurer
parent 8fbc513da7
commit 026cc0dccb
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
example/src/main/java/io/netty/example/http2/client/Http2SettingsHandler.java
View File

@ -40,7 +40,7 @@ public class Http2SettingsHandler extends SimpleChannelInboundHandler<Http2Setti
* handshake to complete. * handshake to complete.
* *
* @param timeout Time to wait * @param timeout Time to wait
* @param Units for {@code timeout} * @param unit {@link TimeUnit} for {@code timeout}
* @throws Exception if timeout or other failure occurs * @throws Exception if timeout or other failure occurs
*/ */
public void awaitSettings(long timeout, TimeUnit unit) throws Exception { public void awaitSettings(long timeout, TimeUnit unit) throws Exception {

4
example/src/main/java/io/netty/example/http2/client/HttpResponseHandler.java
View File

@ -45,7 +45,7 @@ public class HttpResponseHandler extends SimpleChannelInboundHandler<FullHttpRes
* @param streamId The stream for which a response is expected * @param streamId The stream for which a response is expected
* @param promise The promise object that will be used to wait/notify events * @param promise The promise object that will be used to wait/notify events
* @return The previous object associated with {@code streamId} * @return The previous object associated with {@code streamId}
* @see {@link io.netty.example.http2.client.HttpResponseHandler#awaitResponses awaitResponses} * @see HttpResponseHandler#awaitResponses(long, TimeUnit)
*/ */
public ChannelPromise put(int streamId, ChannelPromise promise) { public ChannelPromise put(int streamId, ChannelPromise promise) {
return streamidPromiseMap.put(streamId, promise); return streamidPromiseMap.put(streamId, promise);
@ -56,7 +56,7 @@ public class HttpResponseHandler extends SimpleChannelInboundHandler<FullHttpRes
* *
* @param timeout Value of time to wait for each response * @param timeout Value of time to wait for each response
* @param unit Units associated with {@code timeout} * @param unit Units associated with {@code timeout}
* @see {@link io.netty.example.http2.client.HttpResponseHandler#put put} * @see HttpResponseHandler#put(int, ChannelPromise)
*/ */
public void awaitResponses(long timeout, TimeUnit unit) { public void awaitResponses(long timeout, TimeUnit unit) {
Iterator<Entry<Integer, ChannelPromise>> itr = streamidPromiseMap.entrySet().iterator(); Iterator<Entry<Integer, ChannelPromise>> itr = streamidPromiseMap.entrySet().iterator();