Fix javadoc

slandelle · slandelle · commit fab4bb78ca11 · 2017-04-25T14:57:12.000+02:00
diff --git a/client/src/main/java/org/asynchttpclient/AsyncHandler.java b/client/src/main/java/org/asynchttpclient/AsyncHandler.java
@@ -25,8 +25,9 @@
  * Callback methods get invoked in the following order:
  * <ol>
  *  <li>{@link #onStatusReceived(HttpResponseStatus)},</li>
- *  <li>{@link #onHeadersReceived(HttpResponseHeaders)},</li>
+ *  <li>{@link #onHeadersReceived(HttpHeaders)},</li>
  *  <li>{@link #onBodyPartReceived(HttpResponseBodyPart)}, which could be invoked multiple times,</li>
+ *  <li>{@link #onTrailingHeadersReceived(HttpHeaders)}, which is only invoked if trailing HTTP headers are received</li>
  *  <li>{@link #onCompleted()}, once the response has been fully read.</li>
  * </ol>
  * <br>
@@ -101,9 +102,9 @@ enum State {
     
     /**
      * Invoked when trailing headers have been received. 
-     * @param headers
-     * @return
-     * @throws Exception
+     * @param headers the trailing HTTP headers.
+     * @return a {@link State} telling to CONTINUE or ABORT the current processing.
+     * @throws Exception if something wrong happens
      */
     default State onTrailingHeadersReceived(HttpHeaders headers) throws Exception {
         return State.CONTINUE;
diff --git a/client/src/main/java/org/asynchttpclient/RequestBuilderBase.java b/client/src/main/java/org/asynchttpclient/RequestBuilderBase.java
@@ -181,6 +181,9 @@ public T clearHeaders() {
     }
 
     /**
+     * @param name header name
+     * @param value header value to set
+     * @return {@code this}
      * @see #setHeader(CharSequence, Object)
      */
     public T setHeader(CharSequence name, String value) {
@@ -212,6 +215,9 @@ public T setHeader(CharSequence name, Iterable<?> values) {
     }
 
     /**
+     * @param name header name
+     * @param value header value to add
+     * @return {@code this}
      * @see #addHeader(CharSequence, Object)
      */
     public T addHeader(CharSequence name, String value) {
diff --git a/client/src/main/java/org/asynchttpclient/Response.java b/client/src/main/java/org/asynchttpclient/Response.java
@@ -141,15 +141,15 @@ public interface Response {
 
     /**
      * Return true if the response's headers has been computed by an {@link AsyncHandler} It will return false if the either
-     * {@link AsyncHandler#onStatusReceived(HttpResponseStatus)} or {@link AsyncHandler#onHeadersReceived(HttpResponseHeaders)} returned {@link AsyncHandler.State#ABORT}
+     * {@link AsyncHandler#onStatusReceived(HttpResponseStatus)} or {@link AsyncHandler#onHeadersReceived(HttpHeaders)} returned {@link AsyncHandler.State#ABORT}
      * 
      * @return true if the response's headers has been computed by an {@link AsyncHandler}
      */
     boolean hasResponseHeaders();
 
     /**
      * Return true if the response's body has been computed by an {@link AsyncHandler}. It will return false if the either {@link AsyncHandler#onStatusReceived(HttpResponseStatus)}
-     * or {@link AsyncHandler#onHeadersReceived(HttpResponseHeaders)} returned {@link AsyncHandler.State#ABORT}
+     * or {@link AsyncHandler#onHeadersReceived(HttpHeaders)} returned {@link AsyncHandler.State#ABORT}
      * 
      * @return true if the response's body has been computed by an {@link AsyncHandler}
      */
