- Add generic type documentation
- Add parameter documentation
This commit is contained in:
Gary Gregory 2024-05-22 13:49:54 -04:00
parent 0f37ebdc7d
commit 15b93d481b
3 changed files with 8 additions and 0 deletions

View File

@ -48,6 +48,7 @@ import org.apache.hc.core5.util.Args;
/**
* Abstract {@link HttpClientContext} builder.
*
* @param <T> The HttpClientContext type or subtype.
* @since 5.4
*/
public abstract class AbstractClientContextBuilder<T extends HttpClientContext> {

View File

@ -44,6 +44,8 @@ public class ConnectTimeoutException extends SocketTimeoutException {
/**
* Creates a ConnectTimeoutException with the specified detail message.
*
* @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
*/
public ConnectTimeoutException(final String message) {
super(message);
@ -56,6 +58,9 @@ public class ConnectTimeoutException extends SocketTimeoutException {
}
/**
* Gets the named endpoint.
*
* @return the named endpoint, may be {@code null}.
* @since 5.0
*/
public NamedEndpoint getHost() {

View File

@ -40,6 +40,8 @@ public class UnsupportedSchemeException extends IOException {
/**
* Creates a UnsupportedSchemeException with the specified detail message.
*
* @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
*/
public UnsupportedSchemeException(final String message) {
super(message);