Javadoc improvements

This commit is contained in:
Gary Gregory 2024-08-22 18:14:42 -04:00
parent 01c478b7d8
commit 883dbe3ce7
6 changed files with 9 additions and 0 deletions

View File

@ -31,6 +31,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** /**
* @param <T> the future result type returned by this callback.
* @since 5.2 * @since 5.2
*/ */
public class IgnoreCompleteExceptionFutureCallback<T> implements FutureCallback<T> { public class IgnoreCompleteExceptionFutureCallback<T> implements FutureCallback<T> {

View File

@ -29,6 +29,7 @@ package org.apache.hc.client5.http.async.methods;
import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.concurrent.FutureCallback;
/** /**
* @param <T> the future result type returned by this callback.
* @deprecated Use {@link IgnoreCompleteExceptionFutureCallback} * @deprecated Use {@link IgnoreCompleteExceptionFutureCallback}
* @since 5.2 * @since 5.2
*/ */

View File

@ -194,6 +194,7 @@ public interface HttpClient {
* having to manage resource deallocation internally. * having to manage resource deallocation internally.
* </p> * </p>
* *
* @param <T> the type of the value determined by the response.
* @param request the request to execute * @param request the request to execute
* @param responseHandler the response handler * @param responseHandler the response handler
* *
@ -213,6 +214,7 @@ public interface HttpClient {
* having to manage resource deallocation internally. * having to manage resource deallocation internally.
* </p> * </p>
* *
* @param <T> the type of the value determined by the response.
* @param request the request to execute * @param request the request to execute
* @param context the context to use for the execution, or * @param context the context to use for the execution, or
* {@code null} to use the default context * {@code null} to use the default context
@ -237,6 +239,7 @@ public interface HttpClient {
* having to manage resource deallocation internally. * having to manage resource deallocation internally.
* </p> * </p>
* *
* @param <T> the type of the value determined by the response.
* @param target the target host for the request. * @param target the target host for the request.
* Implementations may accept {@code null} * Implementations may accept {@code null}
* if they can still determine a route, for example * if they can still determine a route, for example
@ -263,6 +266,7 @@ public interface HttpClient {
* having to manage resource deallocation internally. * having to manage resource deallocation internally.
* </p> * </p>
* *
* @param <T> the type of the value determined by the response.
* @param target the target host for the request. * @param target the target host for the request.
* Implementations may accept {@code null} * Implementations may accept {@code null}
* if they can still determine a route, for example * if they can still determine a route, for example

View File

@ -32,6 +32,7 @@ import org.apache.hc.core5.http.HttpMessage;
/** /**
* Abstract HTTP message copier. * Abstract HTTP message copier.
* *
* @param <T> The type of {@link HttpMessage}.
* @since 5.0 * @since 5.0
* *
* @deprecated Use message builders. * @deprecated Use message builders.

View File

@ -29,6 +29,7 @@ package org.apache.hc.client5.http.impl;
import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.Internal;
/** /**
* @param <T> The type of object to store and restore.
* @since 5.4 * @since 5.4
*/ */
@Internal @Internal

View File

@ -49,6 +49,7 @@ import org.apache.hc.core5.http.io.entity.EntityUtils;
* HttpClient may handle redirects (3xx responses) internally. * HttpClient may handle redirects (3xx responses) internally.
* </p> * </p>
* *
* @param <T> the type of the value determined by the response.
* @since 4.4 * @since 4.4
*/ */
@Contract(threading = ThreadingBehavior.STATELESS) @Contract(threading = ThreadingBehavior.STATELESS)